DataStreamTask.html 58 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>DataStreamTask Structure 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/Struct/DataStreamTask" class="dashAnchor"></a>
  16. <a title="DataStreamTask Structure Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire 5.10.2 Docs
  21. </a>
  22. (96% documented)
  23. </p>
  24. <div class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </div>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../img/gh.png" alt="GitHub"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
  37. <img class="header-icon" src="../img/dash.png" alt="Dash"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire</a>
  44. <img class="carat" src="../img/carat.png" alt=""/>
  45. <a class="breadcrumb" href="../Structs.html">Structures</a>
  46. <img class="carat" src="../img/carat.png" alt=""/>
  47. DataStreamTask Structure Reference
  48. </p>
  49. <div class="content-wrapper">
  50. <nav class="navigation">
  51. <ul class="nav-groups">
  52. <li class="nav-group-name">
  53. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  54. <ul class="nav-group-tasks">
  55. <li class="nav-group-task">
  56. <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
  57. </li>
  58. <li class="nav-group-task">
  59. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  60. </li>
  61. <li class="nav-group-task">
  62. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  63. </li>
  64. <li class="nav-group-task">
  65. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  66. </li>
  67. <li class="nav-group-task">
  68. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  69. </li>
  70. <li class="nav-group-task">
  71. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  72. </li>
  73. <li class="nav-group-task">
  74. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  75. </li>
  76. <li class="nav-group-task">
  77. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  78. </li>
  79. <li class="nav-group-task">
  80. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  81. </li>
  82. <li class="nav-group-task">
  83. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  84. </li>
  85. <li class="nav-group-task">
  86. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  87. </li>
  88. <li class="nav-group-task">
  89. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  90. </li>
  91. <li class="nav-group-task">
  92. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  93. </li>
  94. <li class="nav-group-task">
  95. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  96. </li>
  97. <li class="nav-group-task">
  98. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  99. </li>
  100. <li class="nav-group-task">
  101. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  102. </li>
  103. <li class="nav-group-task">
  104. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  105. </li>
  106. <li class="nav-group-task">
  107. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  108. </li>
  109. <li class="nav-group-task">
  110. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  111. </li>
  112. <li class="nav-group-task">
  113. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  114. </li>
  115. <li class="nav-group-task">
  116. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  117. </li>
  118. <li class="nav-group-task">
  119. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  120. </li>
  121. <li class="nav-group-task">
  122. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  123. </li>
  124. <li class="nav-group-task">
  125. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  126. </li>
  127. <li class="nav-group-task">
  128. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  129. </li>
  130. <li class="nav-group-task">
  131. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  132. </li>
  133. <li class="nav-group-task">
  134. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  135. </li>
  136. <li class="nav-group-task">
  137. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  138. </li>
  139. <li class="nav-group-task">
  140. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  141. </li>
  142. <li class="nav-group-task">
  143. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  144. </li>
  145. <li class="nav-group-task">
  146. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  147. </li>
  148. <li class="nav-group-task">
  149. <a class="nav-group-task-link" href="../Classes/Request/ResponseDisposition.html">– ResponseDisposition</a>
  150. </li>
  151. <li class="nav-group-task">
  152. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  153. </li>
  154. <li class="nav-group-task">
  155. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  156. </li>
  157. <li class="nav-group-task">
  158. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  159. </li>
  160. <li class="nav-group-task">
  161. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  162. </li>
  163. <li class="nav-group-task">
  164. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  165. </li>
  166. <li class="nav-group-task">
  167. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  168. </li>
  169. <li class="nav-group-task">
  170. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  171. </li>
  172. <li class="nav-group-task">
  173. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  174. </li>
  175. <li class="nav-group-task">
  176. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  177. </li>
  178. <li class="nav-group-task">
  179. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  180. </li>
  181. <li class="nav-group-task">
  182. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  183. </li>
  184. <li class="nav-group-task">
  185. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  186. </li>
  187. <li class="nav-group-task">
  188. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  189. </li>
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  213. </li>
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  216. </li>
  217. </ul>
  218. </li>
  219. <li class="nav-group-name">
  220. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  221. <ul class="nav-group-tasks">
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  224. </li>
  225. </ul>
  226. </li>
  227. <li class="nav-group-name">
  228. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  229. <ul class="nav-group-tasks">
  230. <li class="nav-group-task">
  231. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  232. </li>
  233. <li class="nav-group-task">
  234. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  235. </li>
  236. <li class="nav-group-task">
  237. <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  238. </li>
  239. <li class="nav-group-task">
  240. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  241. </li>
  242. <li class="nav-group-task">
  243. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  244. </li>
  245. <li class="nav-group-task">
  246. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  247. </li>
  248. <li class="nav-group-task">
  249. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  250. </li>
  251. <li class="nav-group-task">
  252. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  253. </li>
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Enums/AFInfo.html">AFInfo</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  265. </li>
  266. </ul>
  267. </li>
  268. <li class="nav-group-name">
  269. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  270. <ul class="nav-group-tasks">
  271. <li class="nav-group-task">
  272. <a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
  273. </li>
  274. <li class="nav-group-task">
  275. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  276. </li>
  277. <li class="nav-group-task">
  278. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  279. </li>
  280. <li class="nav-group-task">
  281. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  282. </li>
  283. <li class="nav-group-task">
  284. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  285. </li>
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="../Extensions.html#/Protected">Protected</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Extensions/%5BServerTrustEvaluating%5D.html">[ServerTrustEvaluating]</a>
  330. </li>
  331. </ul>
  332. </li>
  333. <li class="nav-group-name">
  334. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  335. <ul class="nav-group-tasks">
  336. <li class="nav-group-task">
  337. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  338. </li>
  339. <li class="nav-group-task">
  340. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  341. </li>
  342. <li class="nav-group-task">
  343. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  344. </li>
  345. <li class="nav-group-task">
  346. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  347. </li>
  348. <li class="nav-group-task">
  349. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  350. </li>
  351. <li class="nav-group-task">
  352. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  353. </li>
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  371. </li>
  372. <li class="nav-group-task">
  373. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  374. </li>
  375. <li class="nav-group-task">
  376. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  377. </li>
  378. <li class="nav-group-task">
  379. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  380. </li>
  381. <li class="nav-group-task">
  382. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  383. </li>
  384. <li class="nav-group-task">
  385. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  386. </li>
  387. <li class="nav-group-task">
  388. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  389. </li>
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Protocols/WebSocketMessageSerializer.html">WebSocketMessageSerializer</a>
  410. </li>
  411. </ul>
  412. </li>
  413. <li class="nav-group-name">
  414. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  415. <ul class="nav-group-tasks">
  416. <li class="nav-group-task">
  417. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  418. </li>
  419. <li class="nav-group-task">
  420. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  421. </li>
  422. <li class="nav-group-task">
  423. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  424. </li>
  425. <li class="nav-group-task">
  426. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  427. </li>
  428. <li class="nav-group-task">
  429. <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
  430. </li>
  431. <li class="nav-group-task">
  432. <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
  433. </li>
  434. <li class="nav-group-task">
  435. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  436. </li>
  437. <li class="nav-group-task">
  438. <a class="nav-group-task-link" href="../Structs/DecodableWebSocketMessageDecoder.html">DecodableWebSocketMessageDecoder</a>
  439. </li>
  440. <li class="nav-group-task">
  441. <a class="nav-group-task-link" href="../Structs/DecodableWebSocketMessageDecoder/Error.html">– Error</a>
  442. </li>
  443. <li class="nav-group-task">
  444. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
  445. </li>
  446. <li class="nav-group-task">
  447. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
  448. </li>
  449. <li class="nav-group-task">
  450. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</a>
  451. </li>
  452. <li class="nav-group-task">
  453. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  454. </li>
  455. <li class="nav-group-task">
  456. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  457. </li>
  458. <li class="nav-group-task">
  459. <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
  460. </li>
  461. <li class="nav-group-task">
  462. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  463. </li>
  464. <li class="nav-group-task">
  465. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  466. </li>
  467. <li class="nav-group-task">
  468. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  469. </li>
  470. <li class="nav-group-task">
  471. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  472. </li>
  473. <li class="nav-group-task">
  474. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  475. </li>
  476. <li class="nav-group-task">
  477. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  478. </li>
  479. <li class="nav-group-task">
  480. <a class="nav-group-task-link" href="../Structs/JSONEncoding/Error.html">– Error</a>
  481. </li>
  482. <li class="nav-group-task">
  483. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  484. </li>
  485. <li class="nav-group-task">
  486. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  487. </li>
  488. <li class="nav-group-task">
  489. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  490. </li>
  491. <li class="nav-group-task">
  492. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  493. </li>
  494. <li class="nav-group-task">
  495. <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
  496. </li>
  497. <li class="nav-group-task">
  498. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  499. </li>
  500. <li class="nav-group-task">
  501. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  502. </li>
  503. <li class="nav-group-task">
  504. <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
  505. </li>
  506. <li class="nav-group-task">
  507. <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
  508. </li>
  509. <li class="nav-group-task">
  510. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  511. </li>
  512. <li class="nav-group-task">
  513. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  514. </li>
  515. <li class="nav-group-task">
  516. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  517. </li>
  518. <li class="nav-group-task">
  519. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  520. </li>
  521. <li class="nav-group-task">
  522. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  523. </li>
  524. <li class="nav-group-task">
  525. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  526. </li>
  527. </ul>
  528. </li>
  529. <li class="nav-group-name">
  530. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  531. <ul class="nav-group-tasks">
  532. <li class="nav-group-task">
  533. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  534. </li>
  535. <li class="nav-group-task">
  536. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  537. </li>
  538. <li class="nav-group-task">
  539. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  540. </li>
  541. <li class="nav-group-task">
  542. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  543. </li>
  544. <li class="nav-group-task">
  545. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  546. </li>
  547. <li class="nav-group-task">
  548. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  549. </li>
  550. <li class="nav-group-task">
  551. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  552. </li>
  553. </ul>
  554. </li>
  555. </ul>
  556. </nav>
  557. <article class="main-content">
  558. <section class="section">
  559. <div class="section-content top-matter">
  560. <h1>DataStreamTask</h1>
  561. <div class="declaration">
  562. <div class="language">
  563. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DataStreamTask</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  564. </div>
  565. </div>
  566. <p>Undocumented</p>
  567. </div>
  568. </section>
  569. <section class="section">
  570. <div class="section-content">
  571. <div class="task-group">
  572. <ul class="item-container">
  573. <li class="item">
  574. <div>
  575. <code>
  576. <a name="/s:9Alamofire14DataStreamTaskV0C0a"></a>
  577. <a name="//apple_ref/swift/Alias/Stream" class="dashAnchor"></a>
  578. <a class="token" href="#/s:9Alamofire14DataStreamTaskV0C0a">Stream</a>
  579. </code>
  580. </div>
  581. <div class="height-container">
  582. <div class="pointer-container"></div>
  583. <section class="section">
  584. <div class="pointer"></div>
  585. <div class="abstract">
  586. <p>Undocumented</p>
  587. </div>
  588. <div class="declaration">
  589. <h4>Declaration</h4>
  590. <div class="language">
  591. <p class="aside-title">Swift</p>
  592. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">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="o">=</span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o">&lt;</span><span class="kt"><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></span><span class="o">.</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;&gt;</span> <span class="k">where</span> <span class="kt">Failure</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  593. </div>
  594. </div>
  595. </section>
  596. </div>
  597. </li>
  598. <li class="item">
  599. <div>
  600. <code>
  601. <a name="/s:9Alamofire14DataStreamTaskV09streamingB023automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_10Foundation0B0Vs5NeverOGGSb_ScS12ContinuationV09BufferingI0OyAR__GtF"></a>
  602. <a name="//apple_ref/swift/Method/streamingData(automaticallyCancelling:bufferingPolicy:)" class="dashAnchor"></a>
  603. <a class="token" href="#/s:9Alamofire14DataStreamTaskV09streamingB023automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_10Foundation0B0Vs5NeverOGGSb_ScS12ContinuationV09BufferingI0OyAR__GtF">streamingData(automaticallyCancelling:<wbr>bufferingPolicy:<wbr>)</a>
  604. </code>
  605. </div>
  606. <div class="height-container">
  607. <div class="pointer-container"></div>
  608. <section class="section">
  609. <div class="pointer"></div>
  610. <div class="abstract">
  611. <p>Creates a <code><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</a></code> of <code>Data</code> values from the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code>.</p>
  612. </div>
  613. <div class="declaration">
  614. <h4>Declaration</h4>
  615. <div class="language">
  616. <p class="aside-title">Swift</p>
  617. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">streamingData</span><span class="p">(</span><span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span> <span class="nv">bufferingPolicy</span><span class="p">:</span> <span class="kt"><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</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="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/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</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></code></pre>
  618. </div>
  619. </div>
  620. <div>
  621. <h4>Parameters</h4>
  622. <table class="graybox">
  623. <tbody>
  624. <tr>
  625. <td>
  626. <code>
  627. <em>shouldAutomaticallyCancel</em>
  628. </code>
  629. </td>
  630. <td>
  631. <div>
  632. <p><code>Bool</code> indicating whether the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> should be canceled
  633. which observation of the stream stops. <code>true</code> by default.</p>
  634. </div>
  635. </td>
  636. </tr>
  637. <tr>
  638. <td>
  639. <code>
  640. <em>bufferingPolicy</em>
  641. </code>
  642. </td>
  643. <td>
  644. <div>
  645. <p><code>BufferingPolicy</code> that determines the stream&rsquo;s buffering behavior.<code>.unbounded</code> by default.</p>
  646. </div>
  647. </td>
  648. </tr>
  649. </tbody>
  650. </table>
  651. </div>
  652. <div>
  653. <h4>Return Value</h4>
  654. <p>The <code><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</a></code>.</p>
  655. </div>
  656. </section>
  657. </div>
  658. </li>
  659. <li class="item">
  660. <div>
  661. <code>
  662. <a name="/s:9Alamofire14DataStreamTaskV16streamingStrings23automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_SSs5NeverOGGSb_ScS12ContinuationV09BufferingJ0OyAO__GtF"></a>
  663. <a name="//apple_ref/swift/Method/streamingStrings(automaticallyCancelling:bufferingPolicy:)" class="dashAnchor"></a>
  664. <a class="token" href="#/s:9Alamofire14DataStreamTaskV16streamingStrings23automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_SSs5NeverOGGSb_ScS12ContinuationV09BufferingJ0OyAO__GtF">streamingStrings(automaticallyCancelling:<wbr>bufferingPolicy:<wbr>)</a>
  665. </code>
  666. </div>
  667. <div class="height-container">
  668. <div class="pointer-container"></div>
  669. <section class="section">
  670. <div class="pointer"></div>
  671. <div class="abstract">
  672. <p>Creates a <code><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</a></code> of <code>UTF-8</code> <code>String</code>s from the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code>.</p>
  673. </div>
  674. <div class="declaration">
  675. <h4>Declaration</h4>
  676. <div class="language">
  677. <p class="aside-title">Swift</p>
  678. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">streamingStrings</span><span class="p">(</span><span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span> <span class="nv">bufferingPolicy</span><span class="p">:</span> <span class="kt"><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</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="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/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</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></code></pre>
  679. </div>
  680. </div>
  681. <div>
  682. <h4>Parameters</h4>
  683. <table class="graybox">
  684. <tbody>
  685. <tr>
  686. <td>
  687. <code>
  688. <em>shouldAutomaticallyCancel</em>
  689. </code>
  690. </td>
  691. <td>
  692. <div>
  693. <p><code>Bool</code> indicating whether the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> should be canceled
  694. which observation of the stream stops. <code>true</code> by default.</p>
  695. </div>
  696. </td>
  697. </tr>
  698. <tr>
  699. <td>
  700. <code>
  701. <em>bufferingPolicy</em>
  702. </code>
  703. </td>
  704. <td>
  705. <div>
  706. <p><code>BufferingPolicy</code> that determines the stream&rsquo;s buffering behavior.<code>.unbounded</code> by default.</p>
  707. </div>
  708. </td>
  709. </tr>
  710. </tbody>
  711. </table>
  712. </div>
  713. <div>
  714. <h4>Return Value</h4>
  715. <p></p>
  716. </div>
  717. </section>
  718. </div>
  719. </li>
  720. <li class="item">
  721. <div>
  722. <code>
  723. <a name="/s:9Alamofire14DataStreamTaskV19streamingDecodables_23automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_xAA7AFErrorOGGxm_SbScS12ContinuationV09BufferingJ0OyAO__GtSeRzs8SendableRzlF"></a>
  724. <a name="//apple_ref/swift/Method/streamingDecodables(_:automaticallyCancelling:bufferingPolicy:)" class="dashAnchor"></a>
  725. <a class="token" href="#/s:9Alamofire14DataStreamTaskV19streamingDecodables_23automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_xAA7AFErrorOGGxm_SbScS12ContinuationV09BufferingJ0OyAO__GtSeRzs8SendableRzlF">streamingDecodables(_:<wbr>automaticallyCancelling:<wbr>bufferingPolicy:<wbr>)</a>
  726. </code>
  727. </div>
  728. <div class="height-container">
  729. <div class="pointer-container"></div>
  730. <section class="section">
  731. <div class="pointer"></div>
  732. <div class="abstract">
  733. <p>Creates a <code><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</a></code> of <code>Decodable</code> values from the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code>.</p>
  734. </div>
  735. <div class="declaration">
  736. <h4>Declaration</h4>
  737. <div class="language">
  738. <p class="aside-title">Swift</p>
  739. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">streamingDecodables</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</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>
  740. <span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
  741. <span class="nv">bufferingPolicy</span><span class="p">:</span> <span class="kt"><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</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="kt">BufferingPolicy</span> <span class="o">=</span> <span class="o">.</span><span class="n">unbounded</span><span class="p">)</span>
  742. <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</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="k">where</span> <span class="kt">T</span><span class="p">:</span> <span class="kt">Decodable</span> <span class="o">&amp;</span> <span class="kt">Sendable</span></code></pre>
  743. </div>
  744. </div>
  745. <div>
  746. <h4>Parameters</h4>
  747. <table class="graybox">
  748. <tbody>
  749. <tr>
  750. <td>
  751. <code>
  752. <em>type</em>
  753. </code>
  754. </td>
  755. <td>
  756. <div>
  757. <p><code>Decodable</code> type to be serialized from stream payloads.</p>
  758. </div>
  759. </td>
  760. </tr>
  761. <tr>
  762. <td>
  763. <code>
  764. <em>shouldAutomaticallyCancel</em>
  765. </code>
  766. </td>
  767. <td>
  768. <div>
  769. <p><code>Bool</code> indicating whether the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> should be canceled
  770. which observation of the stream stops. <code>true</code> by default.</p>
  771. </div>
  772. </td>
  773. </tr>
  774. <tr>
  775. <td>
  776. <code>
  777. <em>bufferingPolicy</em>
  778. </code>
  779. </td>
  780. <td>
  781. <div>
  782. <p><code>BufferingPolicy</code> that determines the stream&rsquo;s buffering behavior.<code>.unbounded</code> by default.</p>
  783. </div>
  784. </td>
  785. </tr>
  786. </tbody>
  787. </table>
  788. </div>
  789. <div>
  790. <h4>Return Value</h4>
  791. <p>The <code><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</a></code>.</p>
  792. </div>
  793. </section>
  794. </div>
  795. </li>
  796. <li class="item">
  797. <div>
  798. <code>
  799. <a name="/s:9Alamofire14DataStreamTaskV18streamingResponses15serializedUsing23automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_16SerializedObjectQzAA7AFErrorOGGx_SbScS12ContinuationV09BufferingL0OyAR__GtAA0bC10SerializerRzlF"></a>
  800. <a name="//apple_ref/swift/Method/streamingResponses(serializedUsing:automaticallyCancelling:bufferingPolicy:)" class="dashAnchor"></a>
  801. <a class="token" href="#/s:9Alamofire14DataStreamTaskV18streamingResponses15serializedUsing23automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_16SerializedObjectQzAA7AFErrorOGGx_SbScS12ContinuationV09BufferingL0OyAR__GtAA0bC10SerializerRzlF">streamingResponses(serializedUsing:<wbr>automaticallyCancelling:<wbr>bufferingPolicy:<wbr>)</a>
  802. </code>
  803. </div>
  804. <div class="height-container">
  805. <div class="pointer-container"></div>
  806. <section class="section">
  807. <div class="pointer"></div>
  808. <div class="abstract">
  809. <p>Creates a <code><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</a></code> of values using the provided <code><a href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a></code> from the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code>.</p>
  810. </div>
  811. <div class="declaration">
  812. <h4>Declaration</h4>
  813. <div class="language">
  814. <p class="aside-title">Swift</p>
  815. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">streamingResponses</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">serializedUsing</span> <span class="nv">serializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span>
  816. <span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
  817. <span class="nv">bufferingPolicy</span><span class="p">:</span> <span class="kt"><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</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="kt">BufferingPolicy</span> <span class="o">=</span> <span class="o">.</span><span class="n">unbounded</span><span class="p">)</span>
  818. <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</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></code></pre>
  819. </div>
  820. </div>
  821. <div>
  822. <h4>Parameters</h4>
  823. <table class="graybox">
  824. <tbody>
  825. <tr>
  826. <td>
  827. <code>
  828. <em>serializer</em>
  829. </code>
  830. </td>
  831. <td>
  832. <div>
  833. <p><code><a href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a></code> to use to serialize incoming <code>Data</code>.</p>
  834. </div>
  835. </td>
  836. </tr>
  837. <tr>
  838. <td>
  839. <code>
  840. <em>shouldAutomaticallyCancel</em>
  841. </code>
  842. </td>
  843. <td>
  844. <div>
  845. <p><code>Bool</code> indicating whether the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> should be canceled
  846. which observation of the stream stops. <code>true</code> by default.</p>
  847. </div>
  848. </td>
  849. </tr>
  850. <tr>
  851. <td>
  852. <code>
  853. <em>bufferingPolicy</em>
  854. </code>
  855. </td>
  856. <td>
  857. <div>
  858. <p><code>BufferingPolicy</code> that determines the stream&rsquo;s buffering behavior.<code>.unbounded</code> by default.</p>
  859. </div>
  860. </td>
  861. </tr>
  862. </tbody>
  863. </table>
  864. </div>
  865. <div>
  866. <h4>Return Value</h4>
  867. <p>The <code><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</a></code>.</p>
  868. </div>
  869. </section>
  870. </div>
  871. </li>
  872. <li class="item">
  873. <div>
  874. <code>
  875. <a name="/s:9Alamofire14DataStreamTaskV6cancelyyF"></a>
  876. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  877. <a class="token" href="#/s:9Alamofire14DataStreamTaskV6cancelyyF">cancel()</a>
  878. </code>
  879. </div>
  880. <div class="height-container">
  881. <div class="pointer-container"></div>
  882. <section class="section">
  883. <div class="pointer"></div>
  884. <div class="abstract">
  885. <p>Cancel the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code>.</p>
  886. </div>
  887. <div class="declaration">
  888. <h4>Declaration</h4>
  889. <div class="language">
  890. <p class="aside-title">Swift</p>
  891. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span></code></pre>
  892. </div>
  893. </div>
  894. </section>
  895. </div>
  896. </li>
  897. <li class="item">
  898. <div>
  899. <code>
  900. <a name="/s:9Alamofire14DataStreamTaskV6resumeyyF"></a>
  901. <a name="//apple_ref/swift/Method/resume()" class="dashAnchor"></a>
  902. <a class="token" href="#/s:9Alamofire14DataStreamTaskV6resumeyyF">resume()</a>
  903. </code>
  904. </div>
  905. <div class="height-container">
  906. <div class="pointer-container"></div>
  907. <section class="section">
  908. <div class="pointer"></div>
  909. <div class="abstract">
  910. <p>Resume the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code>.</p>
  911. </div>
  912. <div class="declaration">
  913. <h4>Declaration</h4>
  914. <div class="language">
  915. <p class="aside-title">Swift</p>
  916. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">resume</span><span class="p">()</span></code></pre>
  917. </div>
  918. </div>
  919. </section>
  920. </div>
  921. </li>
  922. <li class="item">
  923. <div>
  924. <code>
  925. <a name="/s:9Alamofire14DataStreamTaskV7suspendyyF"></a>
  926. <a name="//apple_ref/swift/Method/suspend()" class="dashAnchor"></a>
  927. <a class="token" href="#/s:9Alamofire14DataStreamTaskV7suspendyyF">suspend()</a>
  928. </code>
  929. </div>
  930. <div class="height-container">
  931. <div class="pointer-container"></div>
  932. <section class="section">
  933. <div class="pointer"></div>
  934. <div class="abstract">
  935. <p>Suspend the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code>.</p>
  936. </div>
  937. <div class="declaration">
  938. <h4>Declaration</h4>
  939. <div class="language">
  940. <p class="aside-title">Swift</p>
  941. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">suspend</span><span class="p">()</span></code></pre>
  942. </div>
  943. </div>
  944. </section>
  945. </div>
  946. </li>
  947. </ul>
  948. </div>
  949. </div>
  950. </section>
  951. </article>
  952. </div>
  953. <section class="footer">
  954. <p>&copy; 2024 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2024-11-24)</p>
  955. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  956. </section>
  957. </body>
  958. </html>