DataStreamRequest.html 116 KB

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