2
0

DataStreamRequest.html 97 KB

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