DataStreamRequest.html 93 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>DataStreamRequest Class Reference</title>
  5. <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
  6. <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
  7. <meta charset="utf-8">
  8. <script src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. <script src="../js/lunr.min.js" defer></script>
  11. <script src="../js/typeahead.jquery.js" defer></script>
  12. <script src="../js/jazzy.search.js" defer></script>
  13. </head>
  14. <body>
  15. <a name="//apple_ref/swift/Class/DataStreamRequest" class="dashAnchor"></a>
  16. <a title="DataStreamRequest Class Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire 5.4.0 Docs
  21. </a>
  22. (97% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../img/gh.png"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
  37. <img class="header-icon" src="../img/dash.png"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  44. <img class="carat" src="../img/carat.png" />
  45. DataStreamRequest Class Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  205. </li>
  206. </ul>
  207. </li>
  208. <li class="nav-group-name">
  209. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  210. <ul class="nav-group-tasks">
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="nav-group-name">
  217. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  218. <ul class="nav-group-tasks">
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  248. </li>
  249. </ul>
  250. </li>
  251. <li class="nav-group-name">
  252. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  253. <ul class="nav-group-tasks">
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  307. </li>
  308. </ul>
  309. </li>
  310. <li class="nav-group-name">
  311. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  312. <ul class="nav-group-tasks">
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  384. </li>
  385. </ul>
  386. </li>
  387. <li class="nav-group-name">
  388. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  389. <ul class="nav-group-tasks">
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  464. </li>
  465. </ul>
  466. </li>
  467. <li class="nav-group-name">
  468. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  469. <ul class="nav-group-tasks">
  470. <li class="nav-group-task">
  471. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  472. </li>
  473. <li class="nav-group-task">
  474. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  475. </li>
  476. <li class="nav-group-task">
  477. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  478. </li>
  479. <li class="nav-group-task">
  480. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  481. </li>
  482. <li class="nav-group-task">
  483. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  484. </li>
  485. <li class="nav-group-task">
  486. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  487. </li>
  488. <li class="nav-group-task">
  489. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  490. </li>
  491. </ul>
  492. </li>
  493. </ul>
  494. </nav>
  495. <article class="main-content">
  496. <section class="section">
  497. <div class="section-content top-matter">
  498. <h1>DataStreamRequest</h1>
  499. <div class="declaration">
  500. <div class="language">
  501. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">DataStreamRequest</span> <span class="p">:</span> <span class="kt"><a href="../Classes/Request.html">Request</a></span></code></pre>
  502. </div>
  503. </div>
  504. <p><code><a href="../Classes/Request.html">Request</a></code> subclass which streams HTTP response <code>Data</code> through a <code>Handler</code> closure.</p>
  505. </div>
  506. </section>
  507. <section class="section">
  508. <div class="section-content">
  509. <div class="task-group">
  510. <ul class="item-container">
  511. <li class="item">
  512. <div>
  513. <code>
  514. <a name="/s:9Alamofire17DataStreamRequestC7Handlera"></a>
  515. <a name="//apple_ref/swift/Alias/Handler" class="dashAnchor"></a>
  516. <a class="token" href="#/s:9Alamofire17DataStreamRequestC7Handlera">Handler</a>
  517. </code>
  518. </div>
  519. <div class="height-container">
  520. <div class="pointer-container"></div>
  521. <section class="section">
  522. <div class="pointer"></div>
  523. <div class="abstract">
  524. <p>Closure type handling <code><a href="../Classes/DataStreamRequest/Stream.html">DataStreamRequest.Stream</a></code> values.</p>
  525. </div>
  526. <div class="declaration">
  527. <h4>Declaration</h4>
  528. <div class="language">
  529. <p class="aside-title">Swift</p>
  530. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Handler</span><span class="o">&lt;</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">&gt;</span> <span class="o">=</span> <span class="p">(</span><span class="kt"><a href="../Classes/DataStreamRequest/Stream.html">Stream</a></span><span class="o">&lt;</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">&gt;</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">Void</span> <span class="k">where</span> <span class="kt">Failure</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  531. </div>
  532. </div>
  533. </section>
  534. </div>
  535. </li>
  536. <li class="item">
  537. <div>
  538. <code>
  539. <a name="/s:9Alamofire17DataStreamRequestC0C0V"></a>
  540. <a name="//apple_ref/swift/Struct/Stream" class="dashAnchor"></a>
  541. <a class="token" href="#/s:9Alamofire17DataStreamRequestC0C0V">Stream</a>
  542. </code>
  543. </div>
  544. <div class="height-container">
  545. <div class="pointer-container"></div>
  546. <section class="section">
  547. <div class="pointer"></div>
  548. <div class="abstract">
  549. <p>Type encapsulating an <code><a href="../Classes/DataStreamRequest/Event.html">Event</a></code> as it flows through the stream, as well as a <code><a href="../Classes/DataStreamRequest/CancellationToken.html">CancellationToken</a></code> which can be used
  550. to stop the stream at any time.</p>
  551. <a href="../Classes/DataStreamRequest/Stream.html" class="slightly-smaller">See more</a>
  552. </div>
  553. <div class="declaration">
  554. <h4>Declaration</h4>
  555. <div class="language">
  556. <p class="aside-title">Swift</p>
  557. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Stream</span><span class="o">&lt;</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">Failure</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  558. </div>
  559. </div>
  560. </section>
  561. </div>
  562. </li>
  563. <li class="item">
  564. <div>
  565. <code>
  566. <a name="/s:9Alamofire17DataStreamRequestC5EventO"></a>
  567. <a name="//apple_ref/swift/Enum/Event" class="dashAnchor"></a>
  568. <a class="token" href="#/s:9Alamofire17DataStreamRequestC5EventO">Event</a>
  569. </code>
  570. </div>
  571. <div class="height-container">
  572. <div class="pointer-container"></div>
  573. <section class="section">
  574. <div class="pointer"></div>
  575. <div class="abstract">
  576. <p>Type representing an event flowing through the stream. Contains either the <code>Result</code> of processing streamed
  577. <code>Data</code> or the completion of the stream.</p>
  578. <a href="../Classes/DataStreamRequest/Event.html" class="slightly-smaller">See more</a>
  579. </div>
  580. <div class="declaration">
  581. <h4>Declaration</h4>
  582. <div class="language">
  583. <p class="aside-title">Swift</p>
  584. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Event</span><span class="o">&lt;</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">Failure</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  585. </div>
  586. </div>
  587. </section>
  588. </div>
  589. </li>
  590. <li class="item">
  591. <div>
  592. <code>
  593. <a name="/s:9Alamofire17DataStreamRequestC10CompletionV"></a>
  594. <a name="//apple_ref/swift/Struct/Completion" class="dashAnchor"></a>
  595. <a class="token" href="#/s:9Alamofire17DataStreamRequestC10CompletionV">Completion</a>
  596. </code>
  597. </div>
  598. <div class="height-container">
  599. <div class="pointer-container"></div>
  600. <section class="section">
  601. <div class="pointer"></div>
  602. <div class="abstract">
  603. <p>Value containing the state of a <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> when the stream was completed.</p>
  604. <a href="../Classes/DataStreamRequest/Completion.html" class="slightly-smaller">See more</a>
  605. </div>
  606. <div class="declaration">
  607. <h4>Declaration</h4>
  608. <div class="language">
  609. <p class="aside-title">Swift</p>
  610. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Completion</span></code></pre>
  611. </div>
  612. </div>
  613. </section>
  614. </div>
  615. </li>
  616. <li class="item">
  617. <div>
  618. <code>
  619. <a name="/s:9Alamofire17DataStreamRequestC17CancellationTokenV"></a>
  620. <a name="//apple_ref/swift/Struct/CancellationToken" class="dashAnchor"></a>
  621. <a class="token" href="#/s:9Alamofire17DataStreamRequestC17CancellationTokenV">CancellationToken</a>
  622. </code>
  623. </div>
  624. <div class="height-container">
  625. <div class="pointer-container"></div>
  626. <section class="section">
  627. <div class="pointer"></div>
  628. <div class="abstract">
  629. <p>Type used to cancel an ongoing stream.</p>
  630. <a href="../Classes/DataStreamRequest/CancellationToken.html" class="slightly-smaller">See more</a>
  631. </div>
  632. <div class="declaration">
  633. <h4>Declaration</h4>
  634. <div class="language">
  635. <p class="aside-title">Swift</p>
  636. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">CancellationToken</span></code></pre>
  637. </div>
  638. </div>
  639. </section>
  640. </div>
  641. </li>
  642. <li class="item">
  643. <div>
  644. <code>
  645. <a name="/s:9Alamofire17DataStreamRequestC11convertibleAA21URLRequestConvertible_pvp"></a>
  646. <a name="//apple_ref/swift/Property/convertible" class="dashAnchor"></a>
  647. <a class="token" href="#/s:9Alamofire17DataStreamRequestC11convertibleAA21URLRequestConvertible_pvp">convertible</a>
  648. </code>
  649. </div>
  650. <div class="height-container">
  651. <div class="pointer-container"></div>
  652. <section class="section">
  653. <div class="pointer"></div>
  654. <div class="abstract">
  655. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value used to create <code>URLRequest</code>s for this instance.</p>
  656. </div>
  657. <div class="declaration">
  658. <h4>Declaration</h4>
  659. <div class="language">
  660. <p class="aside-title">Swift</p>
  661. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span></code></pre>
  662. </div>
  663. </div>
  664. </section>
  665. </div>
  666. </li>
  667. <li class="item">
  668. <div>
  669. <code>
  670. <a name="/s:9Alamofire17DataStreamRequestC021automaticallyCancelOnC5ErrorSbvp"></a>
  671. <a name="//apple_ref/swift/Property/automaticallyCancelOnStreamError" class="dashAnchor"></a>
  672. <a class="token" href="#/s:9Alamofire17DataStreamRequestC021automaticallyCancelOnC5ErrorSbvp">automaticallyCancelOnStreamError</a>
  673. </code>
  674. </div>
  675. <div class="height-container">
  676. <div class="pointer-container"></div>
  677. <section class="section">
  678. <div class="pointer"></div>
  679. <div class="abstract">
  680. <p>Whether or not the instance will be cancelled if stream parsing encounters an error.</p>
  681. </div>
  682. <div class="declaration">
  683. <h4>Declaration</h4>
  684. <div class="language">
  685. <p class="aside-title">Swift</p>
  686. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">automaticallyCancelOnStreamError</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
  687. </div>
  688. </div>
  689. </section>
  690. </div>
  691. </li>
  692. <li class="item">
  693. <div>
  694. <code>
  695. <a name="/s:9Alamofire17DataStreamRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCtcF"></a>
  696. <a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
  697. <a class="token" href="#/s:9Alamofire17DataStreamRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCtcF">validate(_:<wbr>)</a>
  698. </code>
  699. </div>
  700. <div class="height-container">
  701. <div class="pointer-container"></div>
  702. <section class="section">
  703. <div class="pointer"></div>
  704. <div class="abstract">
  705. <p>Validates the <code>URLRequest</code> and <code>HTTPURLResponse</code> received for the instance using the provided <code><a href="../Classes/DataStreamRequest.html#/s:9Alamofire17DataStreamRequestC10Validationa">Validation</a></code> closure.</p>
  706. </div>
  707. <div class="declaration">
  708. <h4>Declaration</h4>
  709. <div class="language">
  710. <p class="aside-title">Swift</p>
  711. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  712. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="n">_</span> <span class="nv">validation</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Classes/DataStreamRequest.html#/s:9Alamofire17DataStreamRequestC10Validationa">Validation</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  713. </div>
  714. </div>
  715. <div>
  716. <h4>Parameters</h4>
  717. <table class="graybox">
  718. <tbody>
  719. <tr>
  720. <td>
  721. <code>
  722. <em>validation</em>
  723. </code>
  724. </td>
  725. <td>
  726. <div>
  727. <p><code><a href="../Classes/DataStreamRequest.html#/s:9Alamofire17DataStreamRequestC10Validationa">Validation</a></code> closure used to validate the request and response.</p>
  728. </div>
  729. </td>
  730. </tr>
  731. </tbody>
  732. </table>
  733. </div>
  734. <div>
  735. <h4>Return Value</h4>
  736. <p>The <code>DataStreamRequest</code>.</p>
  737. </div>
  738. </section>
  739. </div>
  740. </li>
  741. <li class="item">
  742. <div>
  743. <code>
  744. <a name="/s:9Alamofire17DataStreamRequestC07asInputC010bufferSizeSo07NSInputC0CSgSi_tF"></a>
  745. <a name="//apple_ref/swift/Method/asInputStream(bufferSize:)" class="dashAnchor"></a>
  746. <a class="token" href="#/s:9Alamofire17DataStreamRequestC07asInputC010bufferSizeSo07NSInputC0CSgSi_tF">asInputStream(bufferSize:<wbr>)</a>
  747. </code>
  748. </div>
  749. <div class="height-container">
  750. <div class="pointer-container"></div>
  751. <section class="section">
  752. <div class="pointer"></div>
  753. <div class="abstract">
  754. <p>Produces an <code>InputStream</code> that receives the <code>Data</code> received by the instance.</p>
  755. <div class="aside aside-note">
  756. <p class="aside-title">Note</p>
  757. <p>The <code>InputStream</code> produced by this method must have <code>open()</code> called before being able to read <code>Data</code>.
  758. Additionally, this method will automatically call <code>resume()</code> on the instance, regardless of whether or
  759. not the creating session has <code>startRequestsImmediately</code> set to <code>true</code>.</p>
  760. </div>
  761. </div>
  762. <div class="declaration">
  763. <h4>Declaration</h4>
  764. <div class="language">
  765. <p class="aside-title">Swift</p>
  766. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">asInputStream</span><span class="p">(</span><span class="nv">bufferSize</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="mi">1024</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">InputStream</span><span class="p">?</span></code></pre>
  767. </div>
  768. </div>
  769. <div>
  770. <h4>Parameters</h4>
  771. <table class="graybox">
  772. <tbody>
  773. <tr>
  774. <td>
  775. <code>
  776. <em>bufferSize</em>
  777. </code>
  778. </td>
  779. <td>
  780. <div>
  781. <p>Size, in bytes, of the buffer between the <code>OutputStream</code> and <code>InputStream</code>.</p>
  782. </div>
  783. </td>
  784. </tr>
  785. </tbody>
  786. </table>
  787. </div>
  788. <div>
  789. <h4>Return Value</h4>
  790. <p>The <code>InputStream</code> bound to the internal <code>OutboundStream</code>.</p>
  791. </div>
  792. </section>
  793. </div>
  794. </li>
  795. </ul>
  796. </div>
  797. <div class="task-group">
  798. <div class="task-name-container">
  799. <a name="/DataRequest%20%2F%20UploadRequest"></a>
  800. <a name="//apple_ref/swift/Section/DataRequest / UploadRequest" class="dashAnchor"></a>
  801. <div class="section-name-container">
  802. <a class="section-name-link" href="#/DataRequest%20%2F%20UploadRequest"></a>
  803. <h3 class="section-name"><p>DataRequest / UploadRequest</p>
  804. </h3>
  805. </div>
  806. </div>
  807. <ul class="item-container">
  808. <li class="item">
  809. <div>
  810. <code>
  811. <a name="/s:9Alamofire17DataStreamRequestC07publishC05using2onAA0bC9PublisherVy16SerializedObjectQzGx_So17OS_dispatch_queueCtAA0bC10SerializerRzlF"></a>
  812. <a name="//apple_ref/swift/Method/publishStream(using:on:)" class="dashAnchor"></a>
  813. <a class="token" href="#/s:9Alamofire17DataStreamRequestC07publishC05using2onAA0bC9PublisherVy16SerializedObjectQzGx_So17OS_dispatch_queueCtAA0bC10SerializerRzlF">publishStream(using:<wbr>on:<wbr>)</a>
  814. </code>
  815. </div>
  816. <div class="height-container">
  817. <div class="pointer-container"></div>
  818. <section class="section">
  819. <div class="pointer"></div>
  820. <div class="abstract">
  821. <p>Creates a <code><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></code> for this instance using the given <code><a href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a></code> and <code>DispatchQueue</code>.</p>
  822. </div>
  823. <div class="declaration">
  824. <h4>Declaration</h4>
  825. <div class="language">
  826. <p class="aside-title">Swift</p>
  827. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  828. <span class="kd">public</span> <span class="kd">func</span> <span class="n">publishStream</span><span class="o">&lt;</span><span class="kt">Serializer</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a></span><span class="o">&gt;</span><span class="p">(</span><span class="n">using</span> <span class="nv">serializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span>
  829. <span class="n">on</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></span><span class="o">&lt;</span><span class="kt">Serializer</span><span class="o">.</span><span class="kt">SerializedObject</span><span class="o">&gt;</span></code></pre>
  830. </div>
  831. </div>
  832. <div>
  833. <h4>Parameters</h4>
  834. <table class="graybox">
  835. <tbody>
  836. <tr>
  837. <td>
  838. <code>
  839. <em>serializer</em>
  840. </code>
  841. </td>
  842. <td>
  843. <div>
  844. <p><code><a href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a></code> used to serialize the streamed <code>Data</code>.</p>
  845. </div>
  846. </td>
  847. </tr>
  848. <tr>
  849. <td>
  850. <code>
  851. <em>queue</em>
  852. </code>
  853. </td>
  854. <td>
  855. <div>
  856. <p><code>DispatchQueue</code> on which the <code>DataRequest.Stream</code> values will be published. <code>.main</code> by default.</p>
  857. </div>
  858. </td>
  859. </tr>
  860. </tbody>
  861. </table>
  862. </div>
  863. <div>
  864. <h4>Return Value</h4>
  865. <p>The <code><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></code>.</p>
  866. </div>
  867. </section>
  868. </div>
  869. </li>
  870. <li class="item">
  871. <div>
  872. <code>
  873. <a name="/s:9Alamofire17DataStreamRequestC07publishB05queueAA0bC9PublisherVy10Foundation0B0VGSo012OS_dispatch_F0C_tF"></a>
  874. <a name="//apple_ref/swift/Method/publishData(queue:)" class="dashAnchor"></a>
  875. <a class="token" href="#/s:9Alamofire17DataStreamRequestC07publishB05queueAA0bC9PublisherVy10Foundation0B0VGSo012OS_dispatch_F0C_tF">publishData(queue:<wbr>)</a>
  876. </code>
  877. </div>
  878. <div class="height-container">
  879. <div class="pointer-container"></div>
  880. <section class="section">
  881. <div class="pointer"></div>
  882. <div class="abstract">
  883. <p>Creates a <code><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></code> for this instance which uses a <code><a href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a></code> to stream <code>Data</code>
  884. unserialized.</p>
  885. </div>
  886. <div class="declaration">
  887. <h4>Declaration</h4>
  888. <div class="language">
  889. <p class="aside-title">Swift</p>
  890. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  891. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">publishData</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span></code></pre>
  892. </div>
  893. </div>
  894. <div>
  895. <h4>Parameters</h4>
  896. <table class="graybox">
  897. <tbody>
  898. <tr>
  899. <td>
  900. <code>
  901. <em>queue</em>
  902. </code>
  903. </td>
  904. <td>
  905. <div>
  906. <p><code>DispatchQueue</code> on which the <code>DataRequest.Stream</code> values will be published. <code>.main</code> by default.</p>
  907. </div>
  908. </td>
  909. </tr>
  910. </tbody>
  911. </table>
  912. </div>
  913. <div>
  914. <h4>Return Value</h4>
  915. <p>The <code><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></code>.</p>
  916. </div>
  917. </section>
  918. </div>
  919. </li>
  920. <li class="item">
  921. <div>
  922. <code>
  923. <a name="/s:9Alamofire17DataStreamRequestC13publishString5queueAA0bC9PublisherVySSGSo012OS_dispatch_G0C_tF"></a>
  924. <a name="//apple_ref/swift/Method/publishString(queue:)" class="dashAnchor"></a>
  925. <a class="token" href="#/s:9Alamofire17DataStreamRequestC13publishString5queueAA0bC9PublisherVySSGSo012OS_dispatch_G0C_tF">publishString(queue:<wbr>)</a>
  926. </code>
  927. </div>
  928. <div class="height-container">
  929. <div class="pointer-container"></div>
  930. <section class="section">
  931. <div class="pointer"></div>
  932. <div class="abstract">
  933. <p>Creates a <code><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></code> for this instance which uses a <code><a href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a></code> to serialize stream
  934. <code>Data</code> values into <code>String</code> values.</p>
  935. </div>
  936. <div class="declaration">
  937. <h4>Declaration</h4>
  938. <div class="language">
  939. <p class="aside-title">Swift</p>
  940. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  941. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">publishString</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span></code></pre>
  942. </div>
  943. </div>
  944. <div>
  945. <h4>Parameters</h4>
  946. <table class="graybox">
  947. <tbody>
  948. <tr>
  949. <td>
  950. <code>
  951. <em>queue</em>
  952. </code>
  953. </td>
  954. <td>
  955. <div>
  956. <p><code>DispatchQueue</code> on which the <code>DataRequest.Stream</code> values will be published. <code>.main</code> by default.</p>
  957. </div>
  958. </td>
  959. </tr>
  960. </tbody>
  961. </table>
  962. </div>
  963. <div>
  964. <h4>Return Value</h4>
  965. <p>The <code><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></code>.</p>
  966. </div>
  967. </section>
  968. </div>
  969. </li>
  970. <li class="item">
  971. <div>
  972. <code>
  973. <a name="/s:9Alamofire17DataStreamRequestC16publishDecodable4type5queue7decoder12preprocessorAA0bC9PublisherVyxGxm_So012OS_dispatch_H0CAA0B7Decoder_pAA0B12Preprocessor_ptSeRzlF"></a>
  974. <a name="//apple_ref/swift/Method/publishDecodable(type:queue:decoder:preprocessor:)" class="dashAnchor"></a>
  975. <a class="token" href="#/s:9Alamofire17DataStreamRequestC16publishDecodable4type5queue7decoder12preprocessorAA0bC9PublisherVyxGxm_So012OS_dispatch_H0CAA0B7Decoder_pAA0B12Preprocessor_ptSeRzlF">publishDecodable(type:<wbr>queue:<wbr>decoder:<wbr>preprocessor:<wbr>)</a>
  976. </code>
  977. </div>
  978. <div class="height-container">
  979. <div class="pointer-container"></div>
  980. <section class="section">
  981. <div class="pointer"></div>
  982. <div class="abstract">
  983. <p>Creates a <code><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></code> for this instance which uses a <code><a href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a></code> with the provided
  984. parameters to serialize stream <code>Data</code> values into the provided type.</p>
  985. </div>
  986. <div class="declaration">
  987. <h4>Declaration</h4>
  988. <div class="language">
  989. <p class="aside-title">Swift</p>
  990. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  991. <span class="kd">public</span> <span class="kd">func</span> <span class="n">publishDecodable</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">:</span> <span class="kt">Decodable</span><span class="o">&gt;</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">T</span><span class="o">.</span><span class="k">Type</span> <span class="o">=</span> <span class="kt">T</span><span class="o">.</span><span class="k">self</span><span class="p">,</span>
  992. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  993. <span class="nv">decoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataDecoder.html">DataDecoder</a></span> <span class="o">=</span> <span class="kt">JSONDecoder</span><span class="p">(),</span>
  994. <span class="nv">preprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a></span><span class="p">())</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span></code></pre>
  995. </div>
  996. </div>
  997. <div>
  998. <h4>Parameters</h4>
  999. <table class="graybox">
  1000. <tbody>
  1001. <tr>
  1002. <td>
  1003. <code>
  1004. <em>type</em>
  1005. </code>
  1006. </td>
  1007. <td>
  1008. <div>
  1009. <p><code>Decodable</code> type to which to decode stream <code>Data</code>. Inferred from the context by default.</p>
  1010. </div>
  1011. </td>
  1012. </tr>
  1013. <tr>
  1014. <td>
  1015. <code>
  1016. <em>queue</em>
  1017. </code>
  1018. </td>
  1019. <td>
  1020. <div>
  1021. <p><code>DispatchQueue</code> on which the <code>DataRequest.Stream</code> values will be published. <code>.main</code> by default.</p>
  1022. </div>
  1023. </td>
  1024. </tr>
  1025. <tr>
  1026. <td>
  1027. <code>
  1028. <em>decoder</em>
  1029. </code>
  1030. </td>
  1031. <td>
  1032. <div>
  1033. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> instance used to decode stream <code>Data</code>. <code>JSONDecoder()</code> by default.</p>
  1034. </div>
  1035. </td>
  1036. </tr>
  1037. <tr>
  1038. <td>
  1039. <code>
  1040. <em>preprocessor</em>
  1041. </code>
  1042. </td>
  1043. <td>
  1044. <div>
  1045. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters incoming stream <code>Data</code> before serialization.
  1046. <code>PassthroughPreprocessor()</code> by default.</p>
  1047. </div>
  1048. </td>
  1049. </tr>
  1050. </tbody>
  1051. </table>
  1052. </div>
  1053. <div>
  1054. <h4>Return Value</h4>
  1055. <p>The <code><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></code>.</p>
  1056. </div>
  1057. </section>
  1058. </div>
  1059. </li>
  1060. </ul>
  1061. </div>
  1062. <div class="task-group">
  1063. <div class="task-name-container">
  1064. <a name="/DataStreamRequest"></a>
  1065. <a name="//apple_ref/swift/Section/DataStreamRequest" class="dashAnchor"></a>
  1066. <div class="section-name-container">
  1067. <a class="section-name-link" href="#/DataStreamRequest"></a>
  1068. <h3 class="section-name"><p>DataStreamRequest</p>
  1069. </h3>
  1070. </div>
  1071. </div>
  1072. <ul class="item-container">
  1073. <li class="item">
  1074. <div>
  1075. <code>
  1076. <a name="/s:9Alamofire17DataStreamRequestC08responseC02on6streamACXDSo17OS_dispatch_queueC_yAC0C0Vy_10Foundation0B0Vs5NeverOGKctF"></a>
  1077. <a name="//apple_ref/swift/Method/responseStream(on:stream:)" class="dashAnchor"></a>
  1078. <a class="token" href="#/s:9Alamofire17DataStreamRequestC08responseC02on6streamACXDSo17OS_dispatch_queueC_yAC0C0Vy_10Foundation0B0Vs5NeverOGKctF">responseStream(on:<wbr>stream:<wbr>)</a>
  1079. </code>
  1080. </div>
  1081. <div class="height-container">
  1082. <div class="pointer-container"></div>
  1083. <section class="section">
  1084. <div class="pointer"></div>
  1085. <div class="abstract">
  1086. <p>Adds a <code>StreamHandler</code> which performs no parsing on incoming <code>Data</code>.</p>
  1087. </div>
  1088. <div class="declaration">
  1089. <h4>Declaration</h4>
  1090. <div class="language">
  1091. <p class="aside-title">Swift</p>
  1092. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1093. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseStream</span><span class="p">(</span><span class="n">on</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span> <span class="nv">stream</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Classes/DataStreamRequest.html#/s:9Alamofire17DataStreamRequestC7Handlera">Handler</a></span><span class="o">&lt;</span><span class="kt">Data</span><span class="p">,</span> <span class="kt">Never</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1094. </div>
  1095. </div>
  1096. <div>
  1097. <h4>Parameters</h4>
  1098. <table class="graybox">
  1099. <tbody>
  1100. <tr>
  1101. <td>
  1102. <code>
  1103. <em>queue</em>
  1104. </code>
  1105. </td>
  1106. <td>
  1107. <div>
  1108. <p><code>DispatchQueue</code> on which to perform <code>StreamHandler</code> closure.</p>
  1109. </div>
  1110. </td>
  1111. </tr>
  1112. <tr>
  1113. <td>
  1114. <code>
  1115. <em>stream</em>
  1116. </code>
  1117. </td>
  1118. <td>
  1119. <div>
  1120. <p><code>StreamHandler</code> closure called as <code>Data</code> is received. May be called multiple times.</p>
  1121. </div>
  1122. </td>
  1123. </tr>
  1124. </tbody>
  1125. </table>
  1126. </div>
  1127. <div>
  1128. <h4>Return Value</h4>
  1129. <p>The <code>DataStreamRequest</code>.</p>
  1130. </div>
  1131. </section>
  1132. </div>
  1133. </li>
  1134. <li class="item">
  1135. <div>
  1136. <code>
  1137. <a name="/s:9Alamofire17DataStreamRequestC08responseC05using2on6streamACXDx_So17OS_dispatch_queueCyAC0C0Vy_16SerializedObjectQzAA7AFErrorOGKctAA0bC10SerializerRzlF"></a>
  1138. <a name="//apple_ref/swift/Method/responseStream(using:on:stream:)" class="dashAnchor"></a>
  1139. <a class="token" href="#/s:9Alamofire17DataStreamRequestC08responseC05using2on6streamACXDx_So17OS_dispatch_queueCyAC0C0Vy_16SerializedObjectQzAA7AFErrorOGKctAA0bC10SerializerRzlF">responseStream(using:<wbr>on:<wbr>stream:<wbr>)</a>
  1140. </code>
  1141. </div>
  1142. <div class="height-container">
  1143. <div class="pointer-container"></div>
  1144. <section class="section">
  1145. <div class="pointer"></div>
  1146. <div class="abstract">
  1147. <p>Adds a <code>StreamHandler</code> which uses the provided <code><a href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a></code> to process incoming <code>Data</code>.</p>
  1148. </div>
  1149. <div class="declaration">
  1150. <h4>Declaration</h4>
  1151. <div class="language">
  1152. <p class="aside-title">Swift</p>
  1153. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1154. <span class="kd">public</span> <span class="kd">func</span> <span class="n">responseStream</span><span class="o">&lt;</span><span class="kt">Serializer</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a></span><span class="o">&gt;</span><span class="p">(</span><span class="n">using</span> <span class="nv">serializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span>
  1155. <span class="n">on</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1156. <span class="nv">stream</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Classes/DataStreamRequest.html#/s:9Alamofire17DataStreamRequestC7Handlera">Handler</a></span><span class="o">&lt;</span><span class="kt">Serializer</span><span class="o">.</span><span class="kt">SerializedObject</span><span class="p">,</span> <span class="kt"><a href="../Enums/AFError.html">AFError</a></span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1157. </div>
  1158. </div>
  1159. <div>
  1160. <h4>Parameters</h4>
  1161. <table class="graybox">
  1162. <tbody>
  1163. <tr>
  1164. <td>
  1165. <code>
  1166. <em>serializer</em>
  1167. </code>
  1168. </td>
  1169. <td>
  1170. <div>
  1171. <p><code><a href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a></code> used to process incoming <code>Data</code>. Its work is done on the <code>serializationQueue</code>.</p>
  1172. </div>
  1173. </td>
  1174. </tr>
  1175. <tr>
  1176. <td>
  1177. <code>
  1178. <em>queue</em>
  1179. </code>
  1180. </td>
  1181. <td>
  1182. <div>
  1183. <p><code>DispatchQueue</code> on which to perform <code>StreamHandler</code> closure.</p>
  1184. </div>
  1185. </td>
  1186. </tr>
  1187. <tr>
  1188. <td>
  1189. <code>
  1190. <em>stream</em>
  1191. </code>
  1192. </td>
  1193. <td>
  1194. <div>
  1195. <p><code>StreamHandler</code> closure called as <code>Data</code> is received. May be called multiple times.</p>
  1196. </div>
  1197. </td>
  1198. </tr>
  1199. </tbody>
  1200. </table>
  1201. </div>
  1202. <div>
  1203. <h4>Return Value</h4>
  1204. <p>The <code>DataStreamRequest</code>.</p>
  1205. </div>
  1206. </section>
  1207. </div>
  1208. </li>
  1209. <li class="item">
  1210. <div>
  1211. <code>
  1212. <a name="/s:9Alamofire17DataStreamRequestC08responseC6String2on6streamACXDSo17OS_dispatch_queueC_yAC0C0Vy_SSs5NeverOGKctF"></a>
  1213. <a name="//apple_ref/swift/Method/responseStreamString(on:stream:)" class="dashAnchor"></a>
  1214. <a class="token" href="#/s:9Alamofire17DataStreamRequestC08responseC6String2on6streamACXDSo17OS_dispatch_queueC_yAC0C0Vy_SSs5NeverOGKctF">responseStreamString(on:<wbr>stream:<wbr>)</a>
  1215. </code>
  1216. </div>
  1217. <div class="height-container">
  1218. <div class="pointer-container"></div>
  1219. <section class="section">
  1220. <div class="pointer"></div>
  1221. <div class="abstract">
  1222. <p>Adds a <code>StreamHandler</code> which parses incoming <code>Data</code> as a UTF8 <code>String</code>.</p>
  1223. </div>
  1224. <div class="declaration">
  1225. <h4>Declaration</h4>
  1226. <div class="language">
  1227. <p class="aside-title">Swift</p>
  1228. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1229. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseStreamString</span><span class="p">(</span><span class="n">on</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1230. <span class="nv">stream</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Classes/DataStreamRequest.html#/s:9Alamofire17DataStreamRequestC7Handlera">Handler</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="p">,</span> <span class="kt">Never</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1231. </div>
  1232. </div>
  1233. <div>
  1234. <h4>Parameters</h4>
  1235. <table class="graybox">
  1236. <tbody>
  1237. <tr>
  1238. <td>
  1239. <code>
  1240. <em>queue</em>
  1241. </code>
  1242. </td>
  1243. <td>
  1244. <div>
  1245. <p><code>DispatchQueue</code> on which to perform <code>StreamHandler</code> closure.</p>
  1246. </div>
  1247. </td>
  1248. </tr>
  1249. <tr>
  1250. <td>
  1251. <code>
  1252. <em>stream</em>
  1253. </code>
  1254. </td>
  1255. <td>
  1256. <div>
  1257. <p><code>StreamHandler</code> closure called as <code>Data</code> is received. May be called multiple times.</p>
  1258. </div>
  1259. </td>
  1260. </tr>
  1261. </tbody>
  1262. </table>
  1263. </div>
  1264. <div>
  1265. <h4>Return Value</h4>
  1266. <p>The <code>DataStreamRequest</code>.</p>
  1267. </div>
  1268. </section>
  1269. </div>
  1270. </li>
  1271. <li class="item">
  1272. <div>
  1273. <code>
  1274. <a name="/s:9Alamofire17DataStreamRequestC08responseC9Decodable2of2on5using12preprocessor6streamACXDxm_So17OS_dispatch_queueCAA0B7Decoder_pAA0B12Preprocessor_pyAC0C0Vy_xAA7AFErrorOGKctSeRzlF"></a>
  1275. <a name="//apple_ref/swift/Method/responseStreamDecodable(of:on:using:preprocessor:stream:)" class="dashAnchor"></a>
  1276. <a class="token" href="#/s:9Alamofire17DataStreamRequestC08responseC9Decodable2of2on5using12preprocessor6streamACXDxm_So17OS_dispatch_queueCAA0B7Decoder_pAA0B12Preprocessor_pyAC0C0Vy_xAA7AFErrorOGKctSeRzlF">responseStreamDecodable(of:<wbr>on:<wbr>using:<wbr>preprocessor:<wbr>stream:<wbr>)</a>
  1277. </code>
  1278. </div>
  1279. <div class="height-container">
  1280. <div class="pointer-container"></div>
  1281. <section class="section">
  1282. <div class="pointer"></div>
  1283. <div class="abstract">
  1284. <p>Adds a <code>StreamHandler</code> which parses incoming <code>Data</code> using the provided <code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code>.</p>
  1285. </div>
  1286. <div class="declaration">
  1287. <h4>Declaration</h4>
  1288. <div class="language">
  1289. <p class="aside-title">Swift</p>
  1290. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1291. <span class="kd">public</span> <span class="kd">func</span> <span class="n">responseStreamDecodable</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">:</span> <span class="kt">Decodable</span><span class="o">&gt;</span><span class="p">(</span><span class="n">of</span> <span class="nv">type</span><span class="p">:</span> <span class="kt">T</span><span class="o">.</span><span class="k">Type</span> <span class="o">=</span> <span class="kt">T</span><span class="o">.</span><span class="k">self</span><span class="p">,</span>
  1292. <span class="n">on</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1293. <span class="n">using</span> <span class="nv">decoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataDecoder.html">DataDecoder</a></span> <span class="o">=</span> <span class="kt">JSONDecoder</span><span class="p">(),</span>
  1294. <span class="nv">preprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a></span><span class="p">(),</span>
  1295. <span class="nv">stream</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Classes/DataStreamRequest.html#/s:9Alamofire17DataStreamRequestC7Handlera">Handler</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="p">,</span> <span class="kt"><a href="../Enums/AFError.html">AFError</a></span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1296. </div>
  1297. </div>
  1298. <div>
  1299. <h4>Parameters</h4>
  1300. <table class="graybox">
  1301. <tbody>
  1302. <tr>
  1303. <td>
  1304. <code>
  1305. <em>type</em>
  1306. </code>
  1307. </td>
  1308. <td>
  1309. <div>
  1310. <p><code>Decodable</code> type to parse incoming <code>Data</code> into.</p>
  1311. </div>
  1312. </td>
  1313. </tr>
  1314. <tr>
  1315. <td>
  1316. <code>
  1317. <em>queue</em>
  1318. </code>
  1319. </td>
  1320. <td>
  1321. <div>
  1322. <p><code>DispatchQueue</code> on which to perform <code>StreamHandler</code> closure.</p>
  1323. </div>
  1324. </td>
  1325. </tr>
  1326. <tr>
  1327. <td>
  1328. <code>
  1329. <em>decoder</em>
  1330. </code>
  1331. </td>
  1332. <td>
  1333. <div>
  1334. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> used to decode the incoming <code>Data</code>.</p>
  1335. </div>
  1336. </td>
  1337. </tr>
  1338. <tr>
  1339. <td>
  1340. <code>
  1341. <em>preprocessor</em>
  1342. </code>
  1343. </td>
  1344. <td>
  1345. <div>
  1346. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> used to process the incoming <code>Data</code> before it&rsquo;s passed to the <code>decoder</code>.</p>
  1347. </div>
  1348. </td>
  1349. </tr>
  1350. <tr>
  1351. <td>
  1352. <code>
  1353. <em>stream</em>
  1354. </code>
  1355. </td>
  1356. <td>
  1357. <div>
  1358. <p><code>StreamHandler</code> closure called as <code>Data</code> is received. May be called multiple times.</p>
  1359. </div>
  1360. </td>
  1361. </tr>
  1362. </tbody>
  1363. </table>
  1364. </div>
  1365. <div>
  1366. <h4>Return Value</h4>
  1367. <p>The <code>DataStreamRequest</code>.</p>
  1368. </div>
  1369. </section>
  1370. </div>
  1371. </li>
  1372. </ul>
  1373. </div>
  1374. <div class="task-group">
  1375. <ul class="item-container">
  1376. <li class="item">
  1377. <div>
  1378. <code>
  1379. <a name="/s:9Alamofire17DataStreamRequestC10Validationa"></a>
  1380. <a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
  1381. <a class="token" href="#/s:9Alamofire17DataStreamRequestC10Validationa">Validation</a>
  1382. </code>
  1383. </div>
  1384. <div class="height-container">
  1385. <div class="pointer-container"></div>
  1386. <section class="section">
  1387. <div class="pointer"></div>
  1388. <div class="abstract">
  1389. <p>A closure used to validate a request that takes a <code>URLRequest</code> and <code>HTTPURLResponse</code> and returns whether the
  1390. request was valid.</p>
  1391. </div>
  1392. <div class="declaration">
  1393. <h4>Declaration</h4>
  1394. <div class="language">
  1395. <p class="aside-title">Swift</p>
  1396. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Validation</span> <span class="o">=</span> <span class="p">(</span><span class="n">_</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?,</span> <span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">ValidationResult</span></code></pre>
  1397. </div>
  1398. </div>
  1399. </section>
  1400. </div>
  1401. </li>
  1402. <li class="item">
  1403. <div>
  1404. <code>
  1405. <a name="/s:9Alamofire17DataStreamRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF"></a>
  1406. <a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
  1407. <a class="token" href="#/s:9Alamofire17DataStreamRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF">validate(statusCode:<wbr>)</a>
  1408. </code>
  1409. </div>
  1410. <div class="height-container">
  1411. <div class="pointer-container"></div>
  1412. <section class="section">
  1413. <div class="pointer"></div>
  1414. <div class="abstract">
  1415. <p>Validates that the response has a status code in the specified sequence.</p>
  1416. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1417. </div>
  1418. <div class="declaration">
  1419. <h4>Declaration</h4>
  1420. <div class="language">
  1421. <p class="aside-title">Swift</p>
  1422. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1423. <span class="kd">public</span> <span class="kd">func</span> <span class="n">validate</span><span class="o">&lt;</span><span class="kt">S</span><span class="o">&gt;</span><span class="p">(</span><span class="n">statusCode</span> <span class="nv">acceptableStatusCodes</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt">Sequence</span><span class="p">,</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">Int</span></code></pre>
  1424. </div>
  1425. </div>
  1426. <div>
  1427. <h4>Parameters</h4>
  1428. <table class="graybox">
  1429. <tbody>
  1430. <tr>
  1431. <td>
  1432. <code>
  1433. <em>statusCode</em>
  1434. </code>
  1435. </td>
  1436. <td>
  1437. <div>
  1438. <p><code>Sequence</code> of acceptable response status codes.</p>
  1439. </div>
  1440. </td>
  1441. </tr>
  1442. </tbody>
  1443. </table>
  1444. </div>
  1445. <div>
  1446. <h4>Return Value</h4>
  1447. <p>The instance.</p>
  1448. </div>
  1449. </section>
  1450. </div>
  1451. </li>
  1452. <li class="item">
  1453. <div>
  1454. <code>
  1455. <a name="/s:9Alamofire17DataStreamRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF"></a>
  1456. <a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
  1457. <a class="token" href="#/s:9Alamofire17DataStreamRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF">validate(contentType:<wbr>)</a>
  1458. </code>
  1459. </div>
  1460. <div class="height-container">
  1461. <div class="pointer-container"></div>
  1462. <section class="section">
  1463. <div class="pointer"></div>
  1464. <div class="abstract">
  1465. <p>Validates that the response has a content type in the specified sequence.</p>
  1466. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1467. </div>
  1468. <div class="declaration">
  1469. <h4>Declaration</h4>
  1470. <div class="language">
  1471. <p class="aside-title">Swift</p>
  1472. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1473. <span class="kd">public</span> <span class="kd">func</span> <span class="n">validate</span><span class="o">&lt;</span><span class="kt">S</span><span class="o">&gt;</span><span class="p">(</span><span class="n">contentType</span> <span class="nv">acceptableContentTypes</span><span class="p">:</span> <span class="kd">@autoclosure</span> <span class="kd">@escaping</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt">Sequence</span><span class="p">,</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">String</span></code></pre>
  1474. </div>
  1475. </div>
  1476. <div>
  1477. <h4>Parameters</h4>
  1478. <table class="graybox">
  1479. <tbody>
  1480. <tr>
  1481. <td>
  1482. <code>
  1483. <em>contentType</em>
  1484. </code>
  1485. </td>
  1486. <td>
  1487. <div>
  1488. <p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
  1489. </div>
  1490. </td>
  1491. </tr>
  1492. </tbody>
  1493. </table>
  1494. </div>
  1495. <div>
  1496. <h4>Return Value</h4>
  1497. <p>The request.</p>
  1498. </div>
  1499. </section>
  1500. </div>
  1501. </li>
  1502. <li class="item">
  1503. <div>
  1504. <code>
  1505. <a name="/s:9Alamofire17DataStreamRequestC8validateACXDyF"></a>
  1506. <a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
  1507. <a class="token" href="#/s:9Alamofire17DataStreamRequestC8validateACXDyF">validate()</a>
  1508. </code>
  1509. </div>
  1510. <div class="height-container">
  1511. <div class="pointer-container"></div>
  1512. <section class="section">
  1513. <div class="pointer"></div>
  1514. <div class="abstract">
  1515. <p>Validates that the response has a status code in the default acceptable range of 200&hellip;299, and that the content
  1516. type matches any specified in the Accept HTTP header field.</p>
  1517. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1518. </div>
  1519. <div class="declaration">
  1520. <h4>Declaration</h4>
  1521. <div class="language">
  1522. <p class="aside-title">Swift</p>
  1523. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1524. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">validate</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1525. </div>
  1526. </div>
  1527. <div>
  1528. <h4>Return Value</h4>
  1529. <p>The instance.</p>
  1530. </div>
  1531. </section>
  1532. </div>
  1533. </li>
  1534. </ul>
  1535. </div>
  1536. </div>
  1537. </section>
  1538. </article>
  1539. </div>
  1540. <section class="footer">
  1541. <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-12-20)</p>
  1542. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1543. </section>
  1544. </body>
  1545. </div>
  1546. </html>