DataStreamRequest.html 115 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998
  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.8.1 Docs
  21. </a>
  22. (97% documented)
  23. </p>
  24. <div class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </div>
  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" alt="GitHub"/>
  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" alt="Dash"/>
  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" alt=""/>
  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/Request/ResponseDisposition.html">– ResponseDisposition</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  208. </li>
  209. <li class="nav-group-task">
  210. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  211. </li>
  212. <li class="nav-group-task">
  213. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  214. </li>
  215. </ul>
  216. </li>
  217. <li class="nav-group-name">
  218. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  219. <ul class="nav-group-tasks">
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  222. </li>
  223. </ul>
  224. </li>
  225. <li class="nav-group-name">
  226. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  227. <ul class="nav-group-tasks">
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  260. </li>
  261. </ul>
  262. </li>
  263. <li class="nav-group-name">
  264. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  265. <ul class="nav-group-tasks">
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  310. </li>
  311. <li class="nav-group-task">
  312. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  313. </li>
  314. <li class="nav-group-task">
  315. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  316. </li>
  317. <li class="nav-group-task">
  318. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  319. </li>
  320. </ul>
  321. </li>
  322. <li class="nav-group-name">
  323. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  324. <ul class="nav-group-tasks">
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  384. </li>
  385. <li class="nav-group-task">
  386. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  387. </li>
  388. <li class="nav-group-task">
  389. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  390. </li>
  391. <li class="nav-group-task">
  392. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  393. </li>
  394. <li class="nav-group-task">
  395. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  396. </li>
  397. </ul>
  398. </li>
  399. <li class="nav-group-name">
  400. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  401. <ul class="nav-group-tasks">
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/JSONEncoding/Error.html">– Error</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  464. </li>
  465. <li class="nav-group-task">
  466. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  467. </li>
  468. <li class="nav-group-task">
  469. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  470. </li>
  471. <li class="nav-group-task">
  472. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  473. </li>
  474. <li class="nav-group-task">
  475. <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
  476. </li>
  477. <li class="nav-group-task">
  478. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  479. </li>
  480. <li class="nav-group-task">
  481. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  482. </li>
  483. <li class="nav-group-task">
  484. <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
  485. </li>
  486. <li class="nav-group-task">
  487. <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
  488. </li>
  489. <li class="nav-group-task">
  490. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  491. </li>
  492. <li class="nav-group-task">
  493. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  494. </li>
  495. <li class="nav-group-task">
  496. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  497. </li>
  498. <li class="nav-group-task">
  499. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  500. </li>
  501. <li class="nav-group-task">
  502. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  503. </li>
  504. <li class="nav-group-task">
  505. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  506. </li>
  507. </ul>
  508. </li>
  509. <li class="nav-group-name">
  510. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  511. <ul class="nav-group-tasks">
  512. <li class="nav-group-task">
  513. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  514. </li>
  515. <li class="nav-group-task">
  516. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  517. </li>
  518. <li class="nav-group-task">
  519. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  520. </li>
  521. <li class="nav-group-task">
  522. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  523. </li>
  524. <li class="nav-group-task">
  525. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  526. </li>
  527. <li class="nav-group-task">
  528. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  529. </li>
  530. <li class="nav-group-task">
  531. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  532. </li>
  533. </ul>
  534. </li>
  535. </ul>
  536. </nav>
  537. <article class="main-content">
  538. <section class="section">
  539. <div class="section-content top-matter">
  540. <h1>DataStreamRequest</h1>
  541. <div class="declaration">
  542. <div class="language">
  543. <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>
  544. </div>
  545. </div>
  546. <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>
  547. </div>
  548. </section>
  549. <section class="section">
  550. <div class="section-content">
  551. <div class="task-group">
  552. <ul class="item-container">
  553. <li class="item">
  554. <div>
  555. <code>
  556. <a name="/s:9Alamofire17DataStreamRequestC7Handlera"></a>
  557. <a name="//apple_ref/swift/Alias/Handler" class="dashAnchor"></a>
  558. <a class="token" href="#/s:9Alamofire17DataStreamRequestC7Handlera">Handler</a>
  559. </code>
  560. </div>
  561. <div class="height-container">
  562. <div class="pointer-container"></div>
  563. <section class="section">
  564. <div class="pointer"></div>
  565. <div class="abstract">
  566. <p>Closure type handling <code><a href="../Classes/DataStreamRequest/Stream.html">DataStreamRequest.Stream</a></code> values.</p>
  567. </div>
  568. <div class="declaration">
  569. <h4>Declaration</h4>
  570. <div class="language">
  571. <p class="aside-title">Swift</p>
  572. <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>
  573. </div>
  574. </div>
  575. </section>
  576. </div>
  577. </li>
  578. <li class="item">
  579. <div>
  580. <code>
  581. <a name="/s:9Alamofire17DataStreamRequestC0C0V"></a>
  582. <a name="//apple_ref/swift/Struct/Stream" class="dashAnchor"></a>
  583. <a class="token" href="#/s:9Alamofire17DataStreamRequestC0C0V">Stream</a>
  584. </code>
  585. </div>
  586. <div class="height-container">
  587. <div class="pointer-container"></div>
  588. <section class="section">
  589. <div class="pointer"></div>
  590. <div class="abstract">
  591. <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
  592. to stop the stream at any time.</p>
  593. <a href="../Classes/DataStreamRequest/Stream.html" class="slightly-smaller">See more</a>
  594. </div>
  595. <div class="declaration">
  596. <h4>Declaration</h4>
  597. <div class="language">
  598. <p class="aside-title">Swift</p>
  599. <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>
  600. </div>
  601. </div>
  602. </section>
  603. </div>
  604. </li>
  605. <li class="item">
  606. <div>
  607. <code>
  608. <a name="/s:9Alamofire17DataStreamRequestC5EventO"></a>
  609. <a name="//apple_ref/swift/Enum/Event" class="dashAnchor"></a>
  610. <a class="token" href="#/s:9Alamofire17DataStreamRequestC5EventO">Event</a>
  611. </code>
  612. </div>
  613. <div class="height-container">
  614. <div class="pointer-container"></div>
  615. <section class="section">
  616. <div class="pointer"></div>
  617. <div class="abstract">
  618. <p>Type representing an event flowing through the stream. Contains either the <code>Result</code> of processing streamed
  619. <code>Data</code> or the completion of the stream.</p>
  620. <a href="../Classes/DataStreamRequest/Event.html" class="slightly-smaller">See more</a>
  621. </div>
  622. <div class="declaration">
  623. <h4>Declaration</h4>
  624. <div class="language">
  625. <p class="aside-title">Swift</p>
  626. <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>
  627. </div>
  628. </div>
  629. </section>
  630. </div>
  631. </li>
  632. <li class="item">
  633. <div>
  634. <code>
  635. <a name="/s:9Alamofire17DataStreamRequestC10CompletionV"></a>
  636. <a name="//apple_ref/swift/Struct/Completion" class="dashAnchor"></a>
  637. <a class="token" href="#/s:9Alamofire17DataStreamRequestC10CompletionV">Completion</a>
  638. </code>
  639. </div>
  640. <div class="height-container">
  641. <div class="pointer-container"></div>
  642. <section class="section">
  643. <div class="pointer"></div>
  644. <div class="abstract">
  645. <p>Value containing the state of a <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> when the stream was completed.</p>
  646. <a href="../Classes/DataStreamRequest/Completion.html" class="slightly-smaller">See more</a>
  647. </div>
  648. <div class="declaration">
  649. <h4>Declaration</h4>
  650. <div class="language">
  651. <p class="aside-title">Swift</p>
  652. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Completion</span></code></pre>
  653. </div>
  654. </div>
  655. </section>
  656. </div>
  657. </li>
  658. <li class="item">
  659. <div>
  660. <code>
  661. <a name="/s:9Alamofire17DataStreamRequestC17CancellationTokenV"></a>
  662. <a name="//apple_ref/swift/Struct/CancellationToken" class="dashAnchor"></a>
  663. <a class="token" href="#/s:9Alamofire17DataStreamRequestC17CancellationTokenV">CancellationToken</a>
  664. </code>
  665. </div>
  666. <div class="height-container">
  667. <div class="pointer-container"></div>
  668. <section class="section">
  669. <div class="pointer"></div>
  670. <div class="abstract">
  671. <p>Type used to cancel an ongoing stream.</p>
  672. <a href="../Classes/DataStreamRequest/CancellationToken.html" class="slightly-smaller">See more</a>
  673. </div>
  674. <div class="declaration">
  675. <h4>Declaration</h4>
  676. <div class="language">
  677. <p class="aside-title">Swift</p>
  678. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">CancellationToken</span></code></pre>
  679. </div>
  680. </div>
  681. </section>
  682. </div>
  683. </li>
  684. <li class="item">
  685. <div>
  686. <code>
  687. <a name="/s:9Alamofire17DataStreamRequestC11convertibleAA21URLRequestConvertible_pvp"></a>
  688. <a name="//apple_ref/swift/Property/convertible" class="dashAnchor"></a>
  689. <a class="token" href="#/s:9Alamofire17DataStreamRequestC11convertibleAA21URLRequestConvertible_pvp">convertible</a>
  690. </code>
  691. </div>
  692. <div class="height-container">
  693. <div class="pointer-container"></div>
  694. <section class="section">
  695. <div class="pointer"></div>
  696. <div class="abstract">
  697. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value used to create <code>URLRequest</code>s for this instance.</p>
  698. </div>
  699. <div class="declaration">
  700. <h4>Declaration</h4>
  701. <div class="language">
  702. <p class="aside-title">Swift</p>
  703. <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>
  704. </div>
  705. </div>
  706. </section>
  707. </div>
  708. </li>
  709. <li class="item">
  710. <div>
  711. <code>
  712. <a name="/s:9Alamofire17DataStreamRequestC021automaticallyCancelOnC5ErrorSbvp"></a>
  713. <a name="//apple_ref/swift/Property/automaticallyCancelOnStreamError" class="dashAnchor"></a>
  714. <a class="token" href="#/s:9Alamofire17DataStreamRequestC021automaticallyCancelOnC5ErrorSbvp">automaticallyCancelOnStreamError</a>
  715. </code>
  716. </div>
  717. <div class="height-container">
  718. <div class="pointer-container"></div>
  719. <section class="section">
  720. <div class="pointer"></div>
  721. <div class="abstract">
  722. <p>Whether or not the instance will be cancelled if stream parsing encounters an error.</p>
  723. </div>
  724. <div class="declaration">
  725. <h4>Declaration</h4>
  726. <div class="language">
  727. <p class="aside-title">Swift</p>
  728. <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>
  729. </div>
  730. </div>
  731. </section>
  732. </div>
  733. </li>
  734. <li class="item">
  735. <div>
  736. <code>
  737. <a name="/s:9Alamofire17DataStreamRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCtcF"></a>
  738. <a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
  739. <a class="token" href="#/s:9Alamofire17DataStreamRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCtcF">validate(_:<wbr>)</a>
  740. </code>
  741. </div>
  742. <div class="height-container">
  743. <div class="pointer-container"></div>
  744. <section class="section">
  745. <div class="pointer"></div>
  746. <div class="abstract">
  747. <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>
  748. </div>
  749. <div class="declaration">
  750. <h4>Declaration</h4>
  751. <div class="language">
  752. <p class="aside-title">Swift</p>
  753. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  754. <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>
  755. </div>
  756. </div>
  757. <div>
  758. <h4>Parameters</h4>
  759. <table class="graybox">
  760. <tbody>
  761. <tr>
  762. <td>
  763. <code>
  764. <em>validation</em>
  765. </code>
  766. </td>
  767. <td>
  768. <div>
  769. <p><code><a href="../Classes/DataStreamRequest.html#/s:9Alamofire17DataStreamRequestC10Validationa">Validation</a></code> closure used to validate the request and response.</p>
  770. </div>
  771. </td>
  772. </tr>
  773. </tbody>
  774. </table>
  775. </div>
  776. <div>
  777. <h4>Return Value</h4>
  778. <p>The <code>DataStreamRequest</code>.</p>
  779. </div>
  780. </section>
  781. </div>
  782. </li>
  783. <li class="item">
  784. <div>
  785. <code>
  786. <a name="/s:9Alamofire17DataStreamRequestC07asInputC010bufferSizeSo07NSInputC0CSgSi_tF"></a>
  787. <a name="//apple_ref/swift/Method/asInputStream(bufferSize:)" class="dashAnchor"></a>
  788. <a class="token" href="#/s:9Alamofire17DataStreamRequestC07asInputC010bufferSizeSo07NSInputC0CSgSi_tF">asInputStream(bufferSize:<wbr>)</a>
  789. </code>
  790. </div>
  791. <div class="height-container">
  792. <div class="pointer-container"></div>
  793. <section class="section">
  794. <div class="pointer"></div>
  795. <div class="abstract">
  796. <p>Produces an <code>InputStream</code> that receives the <code>Data</code> received by the instance.</p>
  797. <div class="aside aside-note">
  798. <p class="aside-title">Note</p>
  799. <p>The <code>InputStream</code> produced by this method must have <code>open()</code> called before being able to read <code>Data</code>.
  800. Additionally, this method will automatically call <code>resume()</code> on the instance, regardless of whether or
  801. not the creating session has <code>startRequestsImmediately</code> set to <code>true</code>.</p>
  802. </div>
  803. </div>
  804. <div class="declaration">
  805. <h4>Declaration</h4>
  806. <div class="language">
  807. <p class="aside-title">Swift</p>
  808. <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>
  809. </div>
  810. </div>
  811. <div>
  812. <h4>Parameters</h4>
  813. <table class="graybox">
  814. <tbody>
  815. <tr>
  816. <td>
  817. <code>
  818. <em>bufferSize</em>
  819. </code>
  820. </td>
  821. <td>
  822. <div>
  823. <p>Size, in bytes, of the buffer between the <code>OutputStream</code> and <code>InputStream</code>.</p>
  824. </div>
  825. </td>
  826. </tr>
  827. </tbody>
  828. </table>
  829. </div>
  830. <div>
  831. <h4>Return Value</h4>
  832. <p>The <code>InputStream</code> bound to the internal <code>OutboundStream</code>.</p>
  833. </div>
  834. </section>
  835. </div>
  836. </li>
  837. <li class="item">
  838. <div>
  839. <code>
  840. <a name="/s:9Alamofire17DataStreamRequestC14onHTTPResponse0E07performACXDSo17OS_dispatch_queueC_ySo17NSHTTPURLResponseC_yAA0D0C19ResponseDispositionOctctF"></a>
  841. <a name="//apple_ref/swift/Method/onHTTPResponse(on:perform:)" class="dashAnchor"></a>
  842. <a class="token" href="#/s:9Alamofire17DataStreamRequestC14onHTTPResponse0E07performACXDSo17OS_dispatch_queueC_ySo17NSHTTPURLResponseC_yAA0D0C19ResponseDispositionOctctF">onHTTPResponse(on:<wbr>perform:<wbr>)</a>
  843. </code>
  844. </div>
  845. <div class="height-container">
  846. <div class="pointer-container"></div>
  847. <section class="section">
  848. <div class="pointer"></div>
  849. <div class="abstract">
  850. <p>Sets a closure called whenever the <code><a href="../Classes/DataRequest.html">DataRequest</a></code> produces an <code>HTTPURLResponse</code> and providing a completion
  851. handler to return a <code>ResponseDisposition</code> value.</p>
  852. </div>
  853. <div class="declaration">
  854. <h4>Declaration</h4>
  855. <div class="language">
  856. <p class="aside-title">Swift</p>
  857. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  858. <span class="kd">@_disfavoredOverload</span>
  859. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">onHTTPResponse</span><span class="p">(</span>
  860. <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>
  861. <span class="n">perform</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</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>
  862. <span class="n">_</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">ResponseDisposition</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span>
  863. <span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  864. </div>
  865. </div>
  866. <div>
  867. <h4>Parameters</h4>
  868. <table class="graybox">
  869. <tbody>
  870. <tr>
  871. <td>
  872. <code>
  873. <em>queue</em>
  874. </code>
  875. </td>
  876. <td>
  877. <div>
  878. <p><code>DispatchQueue</code> on which the closure will be called. <code>.main</code> by default.</p>
  879. </div>
  880. </td>
  881. </tr>
  882. <tr>
  883. <td>
  884. <code>
  885. <em>handler</em>
  886. </code>
  887. </td>
  888. <td>
  889. <div>
  890. <p>Closure called when the instance produces an <code>HTTPURLResponse</code>. The <code>completionHandler</code> provided
  891. MUST be called, otherwise the request will never complete.</p>
  892. </div>
  893. </td>
  894. </tr>
  895. </tbody>
  896. </table>
  897. </div>
  898. <div>
  899. <h4>Return Value</h4>
  900. <p>The instance.</p>
  901. </div>
  902. </section>
  903. </div>
  904. </li>
  905. <li class="item">
  906. <div>
  907. <code>
  908. <a name="/s:9Alamofire17DataStreamRequestC14onHTTPResponse0E07performACXDSo17OS_dispatch_queueC_ySo17NSHTTPURLResponseCctF"></a>
  909. <a name="//apple_ref/swift/Method/onHTTPResponse(on:perform:)" class="dashAnchor"></a>
  910. <a class="token" href="#/s:9Alamofire17DataStreamRequestC14onHTTPResponse0E07performACXDSo17OS_dispatch_queueC_ySo17NSHTTPURLResponseCctF">onHTTPResponse(on:<wbr>perform:<wbr>)</a>
  911. </code>
  912. </div>
  913. <div class="height-container">
  914. <div class="pointer-container"></div>
  915. <section class="section">
  916. <div class="pointer"></div>
  917. <div class="abstract">
  918. <p>Sets a closure called whenever the <code><a href="../Classes/DataRequest.html">DataRequest</a></code> produces an <code>HTTPURLResponse</code>.</p>
  919. </div>
  920. <div class="declaration">
  921. <h4>Declaration</h4>
  922. <div class="language">
  923. <p class="aside-title">Swift</p>
  924. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  925. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">onHTTPResponse</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>
  926. <span class="n">perform</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">HTTPURLResponse</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  927. </div>
  928. </div>
  929. <div>
  930. <h4>Parameters</h4>
  931. <table class="graybox">
  932. <tbody>
  933. <tr>
  934. <td>
  935. <code>
  936. <em>queue</em>
  937. </code>
  938. </td>
  939. <td>
  940. <div>
  941. <p><code>DispatchQueue</code> on which the closure will be called. <code>.main</code> by default.</p>
  942. </div>
  943. </td>
  944. </tr>
  945. <tr>
  946. <td>
  947. <code>
  948. <em>handler</em>
  949. </code>
  950. </td>
  951. <td>
  952. <div>
  953. <p>Closure called when the instance produces an <code>HTTPURLResponse</code>.</p>
  954. </div>
  955. </td>
  956. </tr>
  957. </tbody>
  958. </table>
  959. </div>
  960. <div>
  961. <h4>Return Value</h4>
  962. <p>The instance.</p>
  963. </div>
  964. </section>
  965. </div>
  966. </li>
  967. </ul>
  968. </div>
  969. <div class="task-group">
  970. <div class="task-name-container">
  971. <a name="/DataRequest%20%2F%20UploadRequest"></a>
  972. <a name="//apple_ref/swift/Section/DataRequest / UploadRequest" class="dashAnchor"></a>
  973. <div class="section-name-container">
  974. <a class="section-name-link" href="#/DataRequest%20%2F%20UploadRequest"></a>
  975. <h3 class="section-name"><span>DataRequest / UploadRequest</span>
  976. </h3>
  977. </div>
  978. </div>
  979. <ul class="item-container">
  980. <li class="item">
  981. <div>
  982. <code>
  983. <a name="/s:9Alamofire17DataStreamRequestC07publishC05using2onAA0bC9PublisherVy16SerializedObjectQzGx_So17OS_dispatch_queueCtAA0bC10SerializerRzlF"></a>
  984. <a name="//apple_ref/swift/Method/publishStream(using:on:)" class="dashAnchor"></a>
  985. <a class="token" href="#/s:9Alamofire17DataStreamRequestC07publishC05using2onAA0bC9PublisherVy16SerializedObjectQzGx_So17OS_dispatch_queueCtAA0bC10SerializerRzlF">publishStream(using:<wbr>on:<wbr>)</a>
  986. </code>
  987. </div>
  988. <div class="height-container">
  989. <div class="pointer-container"></div>
  990. <section class="section">
  991. <div class="pointer"></div>
  992. <div class="abstract">
  993. <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>
  994. </div>
  995. <div class="declaration">
  996. <h4>Declaration</h4>
  997. <div class="language">
  998. <p class="aside-title">Swift</p>
  999. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1000. <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>
  1001. <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>
  1002. </div>
  1003. </div>
  1004. <div>
  1005. <h4>Parameters</h4>
  1006. <table class="graybox">
  1007. <tbody>
  1008. <tr>
  1009. <td>
  1010. <code>
  1011. <em>serializer</em>
  1012. </code>
  1013. </td>
  1014. <td>
  1015. <div>
  1016. <p><code><a href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a></code> used to serialize the streamed <code>Data</code>.</p>
  1017. </div>
  1018. </td>
  1019. </tr>
  1020. <tr>
  1021. <td>
  1022. <code>
  1023. <em>queue</em>
  1024. </code>
  1025. </td>
  1026. <td>
  1027. <div>
  1028. <p><code>DispatchQueue</code> on which the <code>DataRequest.Stream</code> values will be published. <code>.main</code> by default.</p>
  1029. </div>
  1030. </td>
  1031. </tr>
  1032. </tbody>
  1033. </table>
  1034. </div>
  1035. <div>
  1036. <h4>Return Value</h4>
  1037. <p>The <code><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></code>.</p>
  1038. </div>
  1039. </section>
  1040. </div>
  1041. </li>
  1042. <li class="item">
  1043. <div>
  1044. <code>
  1045. <a name="/s:9Alamofire17DataStreamRequestC07publishB05queueAA0bC9PublisherVy10Foundation0B0VGSo012OS_dispatch_F0C_tF"></a>
  1046. <a name="//apple_ref/swift/Method/publishData(queue:)" class="dashAnchor"></a>
  1047. <a class="token" href="#/s:9Alamofire17DataStreamRequestC07publishB05queueAA0bC9PublisherVy10Foundation0B0VGSo012OS_dispatch_F0C_tF">publishData(queue:<wbr>)</a>
  1048. </code>
  1049. </div>
  1050. <div class="height-container">
  1051. <div class="pointer-container"></div>
  1052. <section class="section">
  1053. <div class="pointer"></div>
  1054. <div class="abstract">
  1055. <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>
  1056. unserialized.</p>
  1057. </div>
  1058. <div class="declaration">
  1059. <h4>Declaration</h4>
  1060. <div class="language">
  1061. <p class="aside-title">Swift</p>
  1062. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1063. <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>
  1064. </div>
  1065. </div>
  1066. <div>
  1067. <h4>Parameters</h4>
  1068. <table class="graybox">
  1069. <tbody>
  1070. <tr>
  1071. <td>
  1072. <code>
  1073. <em>queue</em>
  1074. </code>
  1075. </td>
  1076. <td>
  1077. <div>
  1078. <p><code>DispatchQueue</code> on which the <code>DataRequest.Stream</code> values will be published. <code>.main</code> by default.</p>
  1079. </div>
  1080. </td>
  1081. </tr>
  1082. </tbody>
  1083. </table>
  1084. </div>
  1085. <div>
  1086. <h4>Return Value</h4>
  1087. <p>The <code><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></code>.</p>
  1088. </div>
  1089. </section>
  1090. </div>
  1091. </li>
  1092. <li class="item">
  1093. <div>
  1094. <code>
  1095. <a name="/s:9Alamofire17DataStreamRequestC13publishString5queueAA0bC9PublisherVySSGSo012OS_dispatch_G0C_tF"></a>
  1096. <a name="//apple_ref/swift/Method/publishString(queue:)" class="dashAnchor"></a>
  1097. <a class="token" href="#/s:9Alamofire17DataStreamRequestC13publishString5queueAA0bC9PublisherVySSGSo012OS_dispatch_G0C_tF">publishString(queue:<wbr>)</a>
  1098. </code>
  1099. </div>
  1100. <div class="height-container">
  1101. <div class="pointer-container"></div>
  1102. <section class="section">
  1103. <div class="pointer"></div>
  1104. <div class="abstract">
  1105. <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
  1106. <code>Data</code> values into <code>String</code> values.</p>
  1107. </div>
  1108. <div class="declaration">
  1109. <h4>Declaration</h4>
  1110. <div class="language">
  1111. <p class="aside-title">Swift</p>
  1112. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1113. <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>
  1114. </div>
  1115. </div>
  1116. <div>
  1117. <h4>Parameters</h4>
  1118. <table class="graybox">
  1119. <tbody>
  1120. <tr>
  1121. <td>
  1122. <code>
  1123. <em>queue</em>
  1124. </code>
  1125. </td>
  1126. <td>
  1127. <div>
  1128. <p><code>DispatchQueue</code> on which the <code>DataRequest.Stream</code> values will be published. <code>.main</code> by default.</p>
  1129. </div>
  1130. </td>
  1131. </tr>
  1132. </tbody>
  1133. </table>
  1134. </div>
  1135. <div>
  1136. <h4>Return Value</h4>
  1137. <p>The <code><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></code>.</p>
  1138. </div>
  1139. </section>
  1140. </div>
  1141. </li>
  1142. <li class="item">
  1143. <div>
  1144. <code>
  1145. <a name="/s:9Alamofire17DataStreamRequestC16publishDecodable4type5queue7decoder12preprocessorAA0bC9PublisherVyxGxm_So012OS_dispatch_H0CAA0B7Decoder_pAA0B12Preprocessor_ptSeRzlF"></a>
  1146. <a name="//apple_ref/swift/Method/publishDecodable(type:queue:decoder:preprocessor:)" class="dashAnchor"></a>
  1147. <a class="token" href="#/s:9Alamofire17DataStreamRequestC16publishDecodable4type5queue7decoder12preprocessorAA0bC9PublisherVyxGxm_So012OS_dispatch_H0CAA0B7Decoder_pAA0B12Preprocessor_ptSeRzlF">publishDecodable(type:<wbr>queue:<wbr>decoder:<wbr>preprocessor:<wbr>)</a>
  1148. </code>
  1149. </div>
  1150. <div class="height-container">
  1151. <div class="pointer-container"></div>
  1152. <section class="section">
  1153. <div class="pointer"></div>
  1154. <div class="abstract">
  1155. <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
  1156. parameters to serialize stream <code>Data</code> values into the provided type.</p>
  1157. </div>
  1158. <div class="declaration">
  1159. <h4>Declaration</h4>
  1160. <div class="language">
  1161. <p class="aside-title">Swift</p>
  1162. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1163. <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>
  1164. <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>
  1165. <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>
  1166. <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>
  1167. </div>
  1168. </div>
  1169. <div>
  1170. <h4>Parameters</h4>
  1171. <table class="graybox">
  1172. <tbody>
  1173. <tr>
  1174. <td>
  1175. <code>
  1176. <em>type</em>
  1177. </code>
  1178. </td>
  1179. <td>
  1180. <div>
  1181. <p><code>Decodable</code> type to which to decode stream <code>Data</code>. Inferred from the context by default.</p>
  1182. </div>
  1183. </td>
  1184. </tr>
  1185. <tr>
  1186. <td>
  1187. <code>
  1188. <em>queue</em>
  1189. </code>
  1190. </td>
  1191. <td>
  1192. <div>
  1193. <p><code>DispatchQueue</code> on which the <code>DataRequest.Stream</code> values will be published. <code>.main</code> by default.</p>
  1194. </div>
  1195. </td>
  1196. </tr>
  1197. <tr>
  1198. <td>
  1199. <code>
  1200. <em>decoder</em>
  1201. </code>
  1202. </td>
  1203. <td>
  1204. <div>
  1205. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> instance used to decode stream <code>Data</code>. <code>JSONDecoder()</code> by default.</p>
  1206. </div>
  1207. </td>
  1208. </tr>
  1209. <tr>
  1210. <td>
  1211. <code>
  1212. <em>preprocessor</em>
  1213. </code>
  1214. </td>
  1215. <td>
  1216. <div>
  1217. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters incoming stream <code>Data</code> before serialization.
  1218. <code>PassthroughPreprocessor()</code> by default.</p>
  1219. </div>
  1220. </td>
  1221. </tr>
  1222. </tbody>
  1223. </table>
  1224. </div>
  1225. <div>
  1226. <h4>Return Value</h4>
  1227. <p>The <code><a href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a></code>.</p>
  1228. </div>
  1229. </section>
  1230. </div>
  1231. </li>
  1232. </ul>
  1233. </div>
  1234. <div class="task-group">
  1235. <div class="task-name-container">
  1236. <a name="/DataStreamTask"></a>
  1237. <a name="//apple_ref/swift/Section/DataStreamTask" class="dashAnchor"></a>
  1238. <div class="section-name-container">
  1239. <a class="section-name-link" href="#/DataStreamTask"></a>
  1240. <h3 class="section-name"><span>DataStreamTask</span>
  1241. </h3>
  1242. </div>
  1243. </div>
  1244. <ul class="item-container">
  1245. <li class="item">
  1246. <div>
  1247. <code>
  1248. <a name="/s:9Alamofire17DataStreamRequestC13httpResponses15bufferingPolicyAA0C2OfVySo17NSHTTPURLResponseCGScS12ContinuationV09BufferingH0OyAI__G_tF"></a>
  1249. <a name="//apple_ref/swift/Method/httpResponses(bufferingPolicy:)" class="dashAnchor"></a>
  1250. <a class="token" href="#/s:9Alamofire17DataStreamRequestC13httpResponses15bufferingPolicyAA0C2OfVySo17NSHTTPURLResponseCGScS12ContinuationV09BufferingH0OyAI__G_tF">httpResponses(bufferingPolicy:<wbr>)</a>
  1251. </code>
  1252. </div>
  1253. <div class="height-container">
  1254. <div class="pointer-container"></div>
  1255. <section class="section">
  1256. <div class="pointer"></div>
  1257. <div class="abstract">
  1258. <p>Creates a <code><a href="../Structs/StreamOf.html">StreamOf&lt;HTTPURLResponse&gt;</a></code> for the instance&rsquo;s responses.</p>
  1259. </div>
  1260. <div class="declaration">
  1261. <h4>Declaration</h4>
  1262. <div class="language">
  1263. <p class="aside-title">Swift</p>
  1264. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">httpResponses</span><span class="p">(</span><span class="nv">bufferingPolicy</span><span class="p">:</span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o">&lt;</span><span class="kt">HTTPURLResponse</span><span class="o">&gt;.</span><span class="kt">BufferingPolicy</span> <span class="o">=</span> <span class="o">.</span><span class="n">unbounded</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o">&lt;</span><span class="kt">HTTPURLResponse</span><span class="o">&gt;</span></code></pre>
  1265. </div>
  1266. </div>
  1267. <div>
  1268. <h4>Parameters</h4>
  1269. <table class="graybox">
  1270. <tbody>
  1271. <tr>
  1272. <td>
  1273. <code>
  1274. <em>bufferingPolicy</em>
  1275. </code>
  1276. </td>
  1277. <td>
  1278. <div>
  1279. <p><code>BufferingPolicy</code> that determines the stream&rsquo;s buffering behavior.<code>.unbounded</code> by default.</p>
  1280. </div>
  1281. </td>
  1282. </tr>
  1283. </tbody>
  1284. </table>
  1285. </div>
  1286. <div>
  1287. <h4>Return Value</h4>
  1288. <p>The <code><a href="../Structs/StreamOf.html">StreamOf&lt;HTTPURLResponse&gt;</a></code>.</p>
  1289. </div>
  1290. </section>
  1291. </div>
  1292. </li>
  1293. <li class="item">
  1294. <div>
  1295. <code>
  1296. <a name="/s:9Alamofire17DataStreamRequestC14onHTTPResponse7performACXDAA0D0C19ResponseDispositionOSo17NSHTTPURLResponseCYaYbc_tF"></a>
  1297. <a name="//apple_ref/swift/Method/onHTTPResponse(perform:)" class="dashAnchor"></a>
  1298. <a class="token" href="#/s:9Alamofire17DataStreamRequestC14onHTTPResponse7performACXDAA0D0C19ResponseDispositionOSo17NSHTTPURLResponseCYaYbc_tF">onHTTPResponse(perform:<wbr>)</a>
  1299. </code>
  1300. </div>
  1301. <div class="height-container">
  1302. <div class="pointer-container"></div>
  1303. <section class="section">
  1304. <div class="pointer"></div>
  1305. <div class="abstract">
  1306. <p>Sets an async closure returning a <code><a href="../Classes/Request/ResponseDisposition.html">Request.ResponseDisposition</a></code>, called whenever the <code>DataStreamRequest</code>
  1307. produces an <code>HTTPURLResponse</code>.</p>
  1308. <div class="aside aside-note">
  1309. <p class="aside-title">Note</p>
  1310. <p>Most requests will only produce a single response for each outgoing attempt (initial + retries).
  1311. However, some types of response may trigger multiple <code>HTTPURLResponse</code>s, such as multipart streams,
  1312. where responses after the first will contain the part headers.</p>
  1313. </div>
  1314. </div>
  1315. <div class="declaration">
  1316. <h4>Declaration</h4>
  1317. <div class="language">
  1318. <p class="aside-title">Swift</p>
  1319. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1320. <span class="kd">@_disfavoredOverload</span>
  1321. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">onHTTPResponse</span><span class="p">(</span><span class="n">perform</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kd">@Sendable</span> <span class="p">(</span><span class="kt">HTTPURLResponse</span><span class="p">)</span> <span class="n">async</span> <span class="o">-&gt;</span> <span class="kt">ResponseDisposition</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1322. </div>
  1323. </div>
  1324. <div>
  1325. <h4>Parameters</h4>
  1326. <table class="graybox">
  1327. <tbody>
  1328. <tr>
  1329. <td>
  1330. <code>
  1331. <em>handler</em>
  1332. </code>
  1333. </td>
  1334. <td>
  1335. <div>
  1336. <p>Async closure executed when a new <code>HTTPURLResponse</code> is received and returning a
  1337. <code>ResponseDisposition</code> value. This value determines whether to continue the request or cancel it as
  1338. if <code>cancel()</code> had been called on the instance. Note, this closure is called on an arbitrary thread,
  1339. so any synchronous calls in it will execute in that context.</p>
  1340. </div>
  1341. </td>
  1342. </tr>
  1343. </tbody>
  1344. </table>
  1345. </div>
  1346. <div>
  1347. <h4>Return Value</h4>
  1348. <p>The instance.</p>
  1349. </div>
  1350. </section>
  1351. </div>
  1352. </li>
  1353. <li class="item">
  1354. <div>
  1355. <code>
  1356. <a name="/s:9Alamofire17DataStreamRequestC14onHTTPResponse7performACXDySo17NSHTTPURLResponseCYaYbc_tF"></a>
  1357. <a name="//apple_ref/swift/Method/onHTTPResponse(perform:)" class="dashAnchor"></a>
  1358. <a class="token" href="#/s:9Alamofire17DataStreamRequestC14onHTTPResponse7performACXDySo17NSHTTPURLResponseCYaYbc_tF">onHTTPResponse(perform:<wbr>)</a>
  1359. </code>
  1360. </div>
  1361. <div class="height-container">
  1362. <div class="pointer-container"></div>
  1363. <section class="section">
  1364. <div class="pointer"></div>
  1365. <div class="abstract">
  1366. <p>Sets an async closure called whenever the <code>DataStreamRequest</code> produces an <code>HTTPURLResponse</code>.</p>
  1367. <div class="aside aside-note">
  1368. <p class="aside-title">Note</p>
  1369. <p>Most requests will only produce a single response for each outgoing attempt (initial + retries).
  1370. However, some types of response may trigger multiple <code>HTTPURLResponse</code>s, such as multipart streams,
  1371. where responses after the first will contain the part headers.</p>
  1372. </div>
  1373. </div>
  1374. <div class="declaration">
  1375. <h4>Declaration</h4>
  1376. <div class="language">
  1377. <p class="aside-title">Swift</p>
  1378. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1379. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">onHTTPResponse</span><span class="p">(</span><span class="n">perform</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kd">@Sendable</span> <span class="p">(</span><span class="kt">HTTPURLResponse</span><span class="p">)</span> <span class="n">async</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1380. </div>
  1381. </div>
  1382. <div>
  1383. <h4>Parameters</h4>
  1384. <table class="graybox">
  1385. <tbody>
  1386. <tr>
  1387. <td>
  1388. <code>
  1389. <em>handler</em>
  1390. </code>
  1391. </td>
  1392. <td>
  1393. <div>
  1394. <p>Async closure executed when a new <code>HTTPURLResponse</code> is received. Note, this closure is called on an
  1395. arbitrary thread, so any synchronous calls in it will execute in that context.</p>
  1396. </div>
  1397. </td>
  1398. </tr>
  1399. </tbody>
  1400. </table>
  1401. </div>
  1402. <div>
  1403. <h4>Return Value</h4>
  1404. <p>The instance.</p>
  1405. </div>
  1406. </section>
  1407. </div>
  1408. </li>
  1409. <li class="item">
  1410. <div>
  1411. <code>
  1412. <a name="/s:9Alamofire17DataStreamRequestC10streamTaskAA0bcF0VyF"></a>
  1413. <a name="//apple_ref/swift/Method/streamTask()" class="dashAnchor"></a>
  1414. <a class="token" href="#/s:9Alamofire17DataStreamRequestC10streamTaskAA0bcF0VyF">streamTask()</a>
  1415. </code>
  1416. </div>
  1417. <div class="height-container">
  1418. <div class="pointer-container"></div>
  1419. <section class="section">
  1420. <div class="pointer"></div>
  1421. <div class="abstract">
  1422. <p>Creates a <code><a href="../Structs/DataStreamTask.html">DataStreamTask</a></code> used to <code>await</code> streams of serialized values.</p>
  1423. </div>
  1424. <div class="declaration">
  1425. <h4>Declaration</h4>
  1426. <div class="language">
  1427. <p class="aside-title">Swift</p>
  1428. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">streamTask</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DataStreamTask.html">DataStreamTask</a></span></code></pre>
  1429. </div>
  1430. </div>
  1431. <div>
  1432. <h4>Return Value</h4>
  1433. <p>The <code><a href="../Structs/DataStreamTask.html">DataStreamTask</a></code>.</p>
  1434. </div>
  1435. </section>
  1436. </div>
  1437. </li>
  1438. </ul>
  1439. </div>
  1440. <div class="task-group">
  1441. <div class="task-name-container">
  1442. <a name="/DataStreamRequest"></a>
  1443. <a name="//apple_ref/swift/Section/DataStreamRequest" class="dashAnchor"></a>
  1444. <div class="section-name-container">
  1445. <a class="section-name-link" href="#/DataStreamRequest"></a>
  1446. <h3 class="section-name"><span>DataStreamRequest</span>
  1447. </h3>
  1448. </div>
  1449. </div>
  1450. <ul class="item-container">
  1451. <li class="item">
  1452. <div>
  1453. <code>
  1454. <a name="/s:9Alamofire17DataStreamRequestC08responseC02on6streamACXDSo17OS_dispatch_queueC_yAC0C0Vy_10Foundation0B0Vs5NeverOGKctF"></a>
  1455. <a name="//apple_ref/swift/Method/responseStream(on:stream:)" class="dashAnchor"></a>
  1456. <a class="token" href="#/s:9Alamofire17DataStreamRequestC08responseC02on6streamACXDSo17OS_dispatch_queueC_yAC0C0Vy_10Foundation0B0Vs5NeverOGKctF">responseStream(on:<wbr>stream:<wbr>)</a>
  1457. </code>
  1458. </div>
  1459. <div class="height-container">
  1460. <div class="pointer-container"></div>
  1461. <section class="section">
  1462. <div class="pointer"></div>
  1463. <div class="abstract">
  1464. <p>Adds a <code>StreamHandler</code> which performs no parsing on incoming <code>Data</code>.</p>
  1465. </div>
  1466. <div class="declaration">
  1467. <h4>Declaration</h4>
  1468. <div class="language">
  1469. <p class="aside-title">Swift</p>
  1470. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1471. <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>
  1472. </div>
  1473. </div>
  1474. <div>
  1475. <h4>Parameters</h4>
  1476. <table class="graybox">
  1477. <tbody>
  1478. <tr>
  1479. <td>
  1480. <code>
  1481. <em>queue</em>
  1482. </code>
  1483. </td>
  1484. <td>
  1485. <div>
  1486. <p><code>DispatchQueue</code> on which to perform <code>StreamHandler</code> closure.</p>
  1487. </div>
  1488. </td>
  1489. </tr>
  1490. <tr>
  1491. <td>
  1492. <code>
  1493. <em>stream</em>
  1494. </code>
  1495. </td>
  1496. <td>
  1497. <div>
  1498. <p><code>StreamHandler</code> closure called as <code>Data</code> is received. May be called multiple times.</p>
  1499. </div>
  1500. </td>
  1501. </tr>
  1502. </tbody>
  1503. </table>
  1504. </div>
  1505. <div>
  1506. <h4>Return Value</h4>
  1507. <p>The <code>DataStreamRequest</code>.</p>
  1508. </div>
  1509. </section>
  1510. </div>
  1511. </li>
  1512. <li class="item">
  1513. <div>
  1514. <code>
  1515. <a name="/s:9Alamofire17DataStreamRequestC08responseC05using2on6streamACXDx_So17OS_dispatch_queueCyAC0C0Vy_16SerializedObjectQzAA7AFErrorOGKctAA0bC10SerializerRzlF"></a>
  1516. <a name="//apple_ref/swift/Method/responseStream(using:on:stream:)" class="dashAnchor"></a>
  1517. <a class="token" href="#/s:9Alamofire17DataStreamRequestC08responseC05using2on6streamACXDx_So17OS_dispatch_queueCyAC0C0Vy_16SerializedObjectQzAA7AFErrorOGKctAA0bC10SerializerRzlF">responseStream(using:<wbr>on:<wbr>stream:<wbr>)</a>
  1518. </code>
  1519. </div>
  1520. <div class="height-container">
  1521. <div class="pointer-container"></div>
  1522. <section class="section">
  1523. <div class="pointer"></div>
  1524. <div class="abstract">
  1525. <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>
  1526. </div>
  1527. <div class="declaration">
  1528. <h4>Declaration</h4>
  1529. <div class="language">
  1530. <p class="aside-title">Swift</p>
  1531. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1532. <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>
  1533. <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>
  1534. <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>
  1535. </div>
  1536. </div>
  1537. <div>
  1538. <h4>Parameters</h4>
  1539. <table class="graybox">
  1540. <tbody>
  1541. <tr>
  1542. <td>
  1543. <code>
  1544. <em>serializer</em>
  1545. </code>
  1546. </td>
  1547. <td>
  1548. <div>
  1549. <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>
  1550. </div>
  1551. </td>
  1552. </tr>
  1553. <tr>
  1554. <td>
  1555. <code>
  1556. <em>queue</em>
  1557. </code>
  1558. </td>
  1559. <td>
  1560. <div>
  1561. <p><code>DispatchQueue</code> on which to perform <code>StreamHandler</code> closure.</p>
  1562. </div>
  1563. </td>
  1564. </tr>
  1565. <tr>
  1566. <td>
  1567. <code>
  1568. <em>stream</em>
  1569. </code>
  1570. </td>
  1571. <td>
  1572. <div>
  1573. <p><code>StreamHandler</code> closure called as <code>Data</code> is received. May be called multiple times.</p>
  1574. </div>
  1575. </td>
  1576. </tr>
  1577. </tbody>
  1578. </table>
  1579. </div>
  1580. <div>
  1581. <h4>Return Value</h4>
  1582. <p>The <code>DataStreamRequest</code>.</p>
  1583. </div>
  1584. </section>
  1585. </div>
  1586. </li>
  1587. <li class="item">
  1588. <div>
  1589. <code>
  1590. <a name="/s:9Alamofire17DataStreamRequestC08responseC6String2on6streamACXDSo17OS_dispatch_queueC_yAC0C0Vy_SSs5NeverOGKctF"></a>
  1591. <a name="//apple_ref/swift/Method/responseStreamString(on:stream:)" class="dashAnchor"></a>
  1592. <a class="token" href="#/s:9Alamofire17DataStreamRequestC08responseC6String2on6streamACXDSo17OS_dispatch_queueC_yAC0C0Vy_SSs5NeverOGKctF">responseStreamString(on:<wbr>stream:<wbr>)</a>
  1593. </code>
  1594. </div>
  1595. <div class="height-container">
  1596. <div class="pointer-container"></div>
  1597. <section class="section">
  1598. <div class="pointer"></div>
  1599. <div class="abstract">
  1600. <p>Adds a <code>StreamHandler</code> which parses incoming <code>Data</code> as a UTF8 <code>String</code>.</p>
  1601. </div>
  1602. <div class="declaration">
  1603. <h4>Declaration</h4>
  1604. <div class="language">
  1605. <p class="aside-title">Swift</p>
  1606. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1607. <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>
  1608. <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>
  1609. </div>
  1610. </div>
  1611. <div>
  1612. <h4>Parameters</h4>
  1613. <table class="graybox">
  1614. <tbody>
  1615. <tr>
  1616. <td>
  1617. <code>
  1618. <em>queue</em>
  1619. </code>
  1620. </td>
  1621. <td>
  1622. <div>
  1623. <p><code>DispatchQueue</code> on which to perform <code>StreamHandler</code> closure.</p>
  1624. </div>
  1625. </td>
  1626. </tr>
  1627. <tr>
  1628. <td>
  1629. <code>
  1630. <em>stream</em>
  1631. </code>
  1632. </td>
  1633. <td>
  1634. <div>
  1635. <p><code>StreamHandler</code> closure called as <code>Data</code> is received. May be called multiple times.</p>
  1636. </div>
  1637. </td>
  1638. </tr>
  1639. </tbody>
  1640. </table>
  1641. </div>
  1642. <div>
  1643. <h4>Return Value</h4>
  1644. <p>The <code>DataStreamRequest</code>.</p>
  1645. </div>
  1646. </section>
  1647. </div>
  1648. </li>
  1649. <li class="item">
  1650. <div>
  1651. <code>
  1652. <a name="/s:9Alamofire17DataStreamRequestC08responseC9Decodable2of2on5using12preprocessor6streamACXDxm_So17OS_dispatch_queueCAA0B7Decoder_pAA0B12Preprocessor_pyAC0C0Vy_xAA7AFErrorOGKctSeRzlF"></a>
  1653. <a name="//apple_ref/swift/Method/responseStreamDecodable(of:on:using:preprocessor:stream:)" class="dashAnchor"></a>
  1654. <a class="token" href="#/s:9Alamofire17DataStreamRequestC08responseC9Decodable2of2on5using12preprocessor6streamACXDxm_So17OS_dispatch_queueCAA0B7Decoder_pAA0B12Preprocessor_pyAC0C0Vy_xAA7AFErrorOGKctSeRzlF">responseStreamDecodable(of:<wbr>on:<wbr>using:<wbr>preprocessor:<wbr>stream:<wbr>)</a>
  1655. </code>
  1656. </div>
  1657. <div class="height-container">
  1658. <div class="pointer-container"></div>
  1659. <section class="section">
  1660. <div class="pointer"></div>
  1661. <div class="abstract">
  1662. <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>
  1663. </div>
  1664. <div class="declaration">
  1665. <h4>Declaration</h4>
  1666. <div class="language">
  1667. <p class="aside-title">Swift</p>
  1668. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1669. <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>
  1670. <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>
  1671. <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>
  1672. <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>
  1673. <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>
  1674. </div>
  1675. </div>
  1676. <div>
  1677. <h4>Parameters</h4>
  1678. <table class="graybox">
  1679. <tbody>
  1680. <tr>
  1681. <td>
  1682. <code>
  1683. <em>type</em>
  1684. </code>
  1685. </td>
  1686. <td>
  1687. <div>
  1688. <p><code>Decodable</code> type to parse incoming <code>Data</code> into.</p>
  1689. </div>
  1690. </td>
  1691. </tr>
  1692. <tr>
  1693. <td>
  1694. <code>
  1695. <em>queue</em>
  1696. </code>
  1697. </td>
  1698. <td>
  1699. <div>
  1700. <p><code>DispatchQueue</code> on which to perform <code>StreamHandler</code> closure.</p>
  1701. </div>
  1702. </td>
  1703. </tr>
  1704. <tr>
  1705. <td>
  1706. <code>
  1707. <em>decoder</em>
  1708. </code>
  1709. </td>
  1710. <td>
  1711. <div>
  1712. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> used to decode the incoming <code>Data</code>.</p>
  1713. </div>
  1714. </td>
  1715. </tr>
  1716. <tr>
  1717. <td>
  1718. <code>
  1719. <em>preprocessor</em>
  1720. </code>
  1721. </td>
  1722. <td>
  1723. <div>
  1724. <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>
  1725. </div>
  1726. </td>
  1727. </tr>
  1728. <tr>
  1729. <td>
  1730. <code>
  1731. <em>stream</em>
  1732. </code>
  1733. </td>
  1734. <td>
  1735. <div>
  1736. <p><code>StreamHandler</code> closure called as <code>Data</code> is received. May be called multiple times.</p>
  1737. </div>
  1738. </td>
  1739. </tr>
  1740. </tbody>
  1741. </table>
  1742. </div>
  1743. <div>
  1744. <h4>Return Value</h4>
  1745. <p>The <code>DataStreamRequest</code>.</p>
  1746. </div>
  1747. </section>
  1748. </div>
  1749. </li>
  1750. </ul>
  1751. </div>
  1752. <div class="task-group">
  1753. <ul class="item-container">
  1754. <li class="item">
  1755. <div>
  1756. <code>
  1757. <a name="/s:9Alamofire17DataStreamRequestC10Validationa"></a>
  1758. <a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
  1759. <a class="token" href="#/s:9Alamofire17DataStreamRequestC10Validationa">Validation</a>
  1760. </code>
  1761. </div>
  1762. <div class="height-container">
  1763. <div class="pointer-container"></div>
  1764. <section class="section">
  1765. <div class="pointer"></div>
  1766. <div class="abstract">
  1767. <p>A closure used to validate a request that takes a <code>URLRequest</code> and <code>HTTPURLResponse</code> and returns whether the
  1768. request was valid.</p>
  1769. </div>
  1770. <div class="declaration">
  1771. <h4>Declaration</h4>
  1772. <div class="language">
  1773. <p class="aside-title">Swift</p>
  1774. <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>
  1775. </div>
  1776. </div>
  1777. </section>
  1778. </div>
  1779. </li>
  1780. <li class="item">
  1781. <div>
  1782. <code>
  1783. <a name="/s:9Alamofire17DataStreamRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF"></a>
  1784. <a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
  1785. <a class="token" href="#/s:9Alamofire17DataStreamRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF">validate(statusCode:<wbr>)</a>
  1786. </code>
  1787. </div>
  1788. <div class="height-container">
  1789. <div class="pointer-container"></div>
  1790. <section class="section">
  1791. <div class="pointer"></div>
  1792. <div class="abstract">
  1793. <p>Validates that the response has a status code in the specified sequence.</p>
  1794. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1795. </div>
  1796. <div class="declaration">
  1797. <h4>Declaration</h4>
  1798. <div class="language">
  1799. <p class="aside-title">Swift</p>
  1800. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1801. <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>
  1802. </div>
  1803. </div>
  1804. <div>
  1805. <h4>Parameters</h4>
  1806. <table class="graybox">
  1807. <tbody>
  1808. <tr>
  1809. <td>
  1810. <code>
  1811. <em>acceptableStatusCodes</em>
  1812. </code>
  1813. </td>
  1814. <td>
  1815. <div>
  1816. <p><code>Sequence</code> of acceptable response status codes.</p>
  1817. </div>
  1818. </td>
  1819. </tr>
  1820. </tbody>
  1821. </table>
  1822. </div>
  1823. <div>
  1824. <h4>Return Value</h4>
  1825. <p>The instance.</p>
  1826. </div>
  1827. </section>
  1828. </div>
  1829. </li>
  1830. <li class="item">
  1831. <div>
  1832. <code>
  1833. <a name="/s:9Alamofire17DataStreamRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF"></a>
  1834. <a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
  1835. <a class="token" href="#/s:9Alamofire17DataStreamRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF">validate(contentType:<wbr>)</a>
  1836. </code>
  1837. </div>
  1838. <div class="height-container">
  1839. <div class="pointer-container"></div>
  1840. <section class="section">
  1841. <div class="pointer"></div>
  1842. <div class="abstract">
  1843. <p>Validates that the response has a content type in the specified sequence.</p>
  1844. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1845. </div>
  1846. <div class="declaration">
  1847. <h4>Declaration</h4>
  1848. <div class="language">
  1849. <p class="aside-title">Swift</p>
  1850. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1851. <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>
  1852. </div>
  1853. </div>
  1854. <div>
  1855. <h4>Parameters</h4>
  1856. <table class="graybox">
  1857. <tbody>
  1858. <tr>
  1859. <td>
  1860. <code>
  1861. <em>contentType</em>
  1862. </code>
  1863. </td>
  1864. <td>
  1865. <div>
  1866. <p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
  1867. </div>
  1868. </td>
  1869. </tr>
  1870. </tbody>
  1871. </table>
  1872. </div>
  1873. <div>
  1874. <h4>Return Value</h4>
  1875. <p>The request.</p>
  1876. </div>
  1877. </section>
  1878. </div>
  1879. </li>
  1880. <li class="item">
  1881. <div>
  1882. <code>
  1883. <a name="/s:9Alamofire17DataStreamRequestC8validateACXDyF"></a>
  1884. <a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
  1885. <a class="token" href="#/s:9Alamofire17DataStreamRequestC8validateACXDyF">validate()</a>
  1886. </code>
  1887. </div>
  1888. <div class="height-container">
  1889. <div class="pointer-container"></div>
  1890. <section class="section">
  1891. <div class="pointer"></div>
  1892. <div class="abstract">
  1893. <p>Validates that the response has a status code in the default acceptable range of 200&hellip;299, and that the content
  1894. type matches any specified in the Accept HTTP header field.</p>
  1895. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1896. </div>
  1897. <div class="declaration">
  1898. <h4>Declaration</h4>
  1899. <div class="language">
  1900. <p class="aside-title">Swift</p>
  1901. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1902. <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>
  1903. </div>
  1904. </div>
  1905. <div>
  1906. <h4>Return Value</h4>
  1907. <p>The instance.</p>
  1908. </div>
  1909. </section>
  1910. </div>
  1911. </li>
  1912. </ul>
  1913. </div>
  1914. </div>
  1915. </section>
  1916. </article>
  1917. </div>
  1918. <section class="footer">
  1919. <p>&copy; 2023 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2023-10-25)</p>
  1920. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  1921. </section>
  1922. </body>
  1923. </html>