DataStreamRequest.html 120 KB

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