DataStreamTask.html 56 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948
  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.5.0 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. DataStreamTask Structure 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/SpaceEncoding.html">– SpaceEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  205. </li>
  206. </ul>
  207. </li>
  208. <li class="nav-group-name">
  209. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  210. <ul class="nav-group-tasks">
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="nav-group-name">
  217. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  218. <ul class="nav-group-tasks">
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  251. </li>
  252. </ul>
  253. </li>
  254. <li class="nav-group-name">
  255. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  256. <ul class="nav-group-tasks">
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  310. </li>
  311. </ul>
  312. </li>
  313. <li class="nav-group-name">
  314. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  315. <ul class="nav-group-tasks">
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  384. </li>
  385. <li class="nav-group-task">
  386. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  387. </li>
  388. </ul>
  389. </li>
  390. <li class="nav-group-name">
  391. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  392. <ul class="nav-group-tasks">
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
  464. </li>
  465. <li class="nav-group-task">
  466. <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
  467. </li>
  468. <li class="nav-group-task">
  469. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  470. </li>
  471. <li class="nav-group-task">
  472. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  473. </li>
  474. <li class="nav-group-task">
  475. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  476. </li>
  477. <li class="nav-group-task">
  478. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  479. </li>
  480. <li class="nav-group-task">
  481. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  482. </li>
  483. <li class="nav-group-task">
  484. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  485. </li>
  486. </ul>
  487. </li>
  488. <li class="nav-group-name">
  489. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  490. <ul class="nav-group-tasks">
  491. <li class="nav-group-task">
  492. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  493. </li>
  494. <li class="nav-group-task">
  495. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  496. </li>
  497. <li class="nav-group-task">
  498. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  499. </li>
  500. <li class="nav-group-task">
  501. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  502. </li>
  503. <li class="nav-group-task">
  504. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  505. </li>
  506. <li class="nav-group-task">
  507. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  508. </li>
  509. <li class="nav-group-task">
  510. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  511. </li>
  512. </ul>
  513. </li>
  514. </ul>
  515. </nav>
  516. <article class="main-content">
  517. <section class="section">
  518. <div class="section-content top-matter">
  519. <h1>DataStreamTask</h1>
  520. <div class="declaration">
  521. <div class="language">
  522. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DataStreamTask</span></code></pre>
  523. </div>
  524. </div>
  525. <p>Undocumented</p>
  526. </div>
  527. </section>
  528. <section class="section">
  529. <div class="section-content">
  530. <div class="task-group">
  531. <ul class="item-container">
  532. <li class="item">
  533. <div>
  534. <code>
  535. <a name="/s:9Alamofire14DataStreamTaskV0C0a"></a>
  536. <a name="//apple_ref/swift/Alias/Stream" class="dashAnchor"></a>
  537. <a class="token" href="#/s:9Alamofire14DataStreamTaskV0C0a">Stream</a>
  538. </code>
  539. </div>
  540. <div class="height-container">
  541. <div class="pointer-container"></div>
  542. <section class="section">
  543. <div class="pointer"></div>
  544. <div class="abstract">
  545. <p>Undocumented</p>
  546. </div>
  547. <div class="declaration">
  548. <h4>Declaration</h4>
  549. <div class="language">
  550. <p class="aside-title">Swift</p>
  551. <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>
  552. </div>
  553. </div>
  554. </section>
  555. </div>
  556. </li>
  557. <li class="item">
  558. <div>
  559. <code>
  560. <a name="/s:9Alamofire14DataStreamTaskV09streamingB023automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_10Foundation0B0Vs5NeverOGGSb_ScS12ContinuationV09BufferingI0OyAR__GtF"></a>
  561. <a name="//apple_ref/swift/Method/streamingData(automaticallyCancelling:bufferingPolicy:)" class="dashAnchor"></a>
  562. <a class="token" href="#/s:9Alamofire14DataStreamTaskV09streamingB023automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_10Foundation0B0Vs5NeverOGGSb_ScS12ContinuationV09BufferingI0OyAR__GtF">streamingData(automaticallyCancelling:<wbr>bufferingPolicy:<wbr>)</a>
  563. </code>
  564. </div>
  565. <div class="height-container">
  566. <div class="pointer-container"></div>
  567. <section class="section">
  568. <div class="pointer"></div>
  569. <div class="abstract">
  570. <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>
  571. </div>
  572. <div class="declaration">
  573. <h4>Declaration</h4>
  574. <div class="language">
  575. <p class="aside-title">Swift</p>
  576. <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>
  577. </div>
  578. </div>
  579. <div>
  580. <h4>Parameters</h4>
  581. <table class="graybox">
  582. <tbody>
  583. <tr>
  584. <td>
  585. <code>
  586. <em>shouldAutomaticallyCancel</em>
  587. </code>
  588. </td>
  589. <td>
  590. <div>
  591. <p><code>Bool</code> indicating whether the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> should be canceled
  592. which observation of the stream stops. <code>true</code> by default.</p>
  593. </div>
  594. </td>
  595. </tr>
  596. <tr>
  597. <td>
  598. <code>
  599. <em>bufferingPolicy</em>
  600. </code>
  601. </td>
  602. <td>
  603. <div>
  604. <p><code>BufferingPolicy</code> that determines the stream&rsquo;s buffering behavior.<code>.unbounded</code> by default.</p>
  605. </div>
  606. </td>
  607. </tr>
  608. </tbody>
  609. </table>
  610. </div>
  611. <div>
  612. <h4>Return Value</h4>
  613. <p>The <code><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</a></code>.</p>
  614. </div>
  615. </section>
  616. </div>
  617. </li>
  618. <li class="item">
  619. <div>
  620. <code>
  621. <a name="/s:9Alamofire14DataStreamTaskV16streamingStrings23automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_SSs5NeverOGGSb_ScS12ContinuationV09BufferingJ0OyAO__GtF"></a>
  622. <a name="//apple_ref/swift/Method/streamingStrings(automaticallyCancelling:bufferingPolicy:)" class="dashAnchor"></a>
  623. <a class="token" href="#/s:9Alamofire14DataStreamTaskV16streamingStrings23automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_SSs5NeverOGGSb_ScS12ContinuationV09BufferingJ0OyAO__GtF">streamingStrings(automaticallyCancelling:<wbr>bufferingPolicy:<wbr>)</a>
  624. </code>
  625. </div>
  626. <div class="height-container">
  627. <div class="pointer-container"></div>
  628. <section class="section">
  629. <div class="pointer"></div>
  630. <div class="abstract">
  631. <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>
  632. </div>
  633. <div class="declaration">
  634. <h4>Declaration</h4>
  635. <div class="language">
  636. <p class="aside-title">Swift</p>
  637. <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>
  638. </div>
  639. </div>
  640. <div>
  641. <h4>Parameters</h4>
  642. <table class="graybox">
  643. <tbody>
  644. <tr>
  645. <td>
  646. <code>
  647. <em>shouldAutomaticallyCancel</em>
  648. </code>
  649. </td>
  650. <td>
  651. <div>
  652. <p><code>Bool</code> indicating whether the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> should be canceled
  653. which observation of the stream stops. <code>true</code> by default.</p>
  654. </div>
  655. </td>
  656. </tr>
  657. <tr>
  658. <td>
  659. <code>
  660. <em>bufferingPolicy</em>
  661. </code>
  662. </td>
  663. <td>
  664. <div>
  665. <p><code>BufferingPolicy</code> that determines the stream&rsquo;s buffering behavior.<code>.unbounded</code> by default.</p>
  666. </div>
  667. </td>
  668. </tr>
  669. </tbody>
  670. </table>
  671. </div>
  672. <div>
  673. <h4>Return Value</h4>
  674. <p></p>
  675. </div>
  676. </section>
  677. </div>
  678. </li>
  679. <li class="item">
  680. <div>
  681. <code>
  682. <a name="/s:9Alamofire14DataStreamTaskV19streamingDecodables_23automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_xAA7AFErrorOGGxm_SbScS12ContinuationV09BufferingJ0OyAO__GtSeRzlF"></a>
  683. <a name="//apple_ref/swift/Method/streamingDecodables(_:automaticallyCancelling:bufferingPolicy:)" class="dashAnchor"></a>
  684. <a class="token" href="#/s:9Alamofire14DataStreamTaskV19streamingDecodables_23automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_xAA7AFErrorOGGxm_SbScS12ContinuationV09BufferingJ0OyAO__GtSeRzlF">streamingDecodables(_:<wbr>automaticallyCancelling:<wbr>bufferingPolicy:<wbr>)</a>
  685. </code>
  686. </div>
  687. <div class="height-container">
  688. <div class="pointer-container"></div>
  689. <section class="section">
  690. <div class="pointer"></div>
  691. <div class="abstract">
  692. <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>
  693. </div>
  694. <div class="declaration">
  695. <h4>Declaration</h4>
  696. <div class="language">
  697. <p class="aside-title">Swift</p>
  698. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">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>
  699. <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>
  700. <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>
  701. <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></code></pre>
  702. </div>
  703. </div>
  704. <div>
  705. <h4>Parameters</h4>
  706. <table class="graybox">
  707. <tbody>
  708. <tr>
  709. <td>
  710. <code>
  711. <em>type</em>
  712. </code>
  713. </td>
  714. <td>
  715. <div>
  716. <p><code>Decodable</code> type to be serialized from stream payloads.</p>
  717. </div>
  718. </td>
  719. </tr>
  720. <tr>
  721. <td>
  722. <code>
  723. <em>shouldAutomaticallyCancel</em>
  724. </code>
  725. </td>
  726. <td>
  727. <div>
  728. <p><code>Bool</code> indicating whether the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> should be canceled
  729. which observation of the stream stops. <code>true</code> by default.</p>
  730. </div>
  731. </td>
  732. </tr>
  733. <tr>
  734. <td>
  735. <code>
  736. <em>bufferingPolicy</em>
  737. </code>
  738. </td>
  739. <td>
  740. <div>
  741. <p><code>BufferingPolicy</code> that determines the stream&rsquo;s buffering behavior.<code>.unbounded</code> by default.</p>
  742. </div>
  743. </td>
  744. </tr>
  745. </tbody>
  746. </table>
  747. </div>
  748. <div>
  749. <h4>Return Value</h4>
  750. <p>The <code><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</a></code>.</p>
  751. </div>
  752. </section>
  753. </div>
  754. </li>
  755. <li class="item">
  756. <div>
  757. <code>
  758. <a name="/s:9Alamofire14DataStreamTaskV18streamingResponses15serializedUsing23automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_16SerializedObjectQzAA7AFErrorOGGx_SbScS12ContinuationV09BufferingL0OyAR__GtAA0bC10SerializerRzlF"></a>
  759. <a name="//apple_ref/swift/Method/streamingResponses(serializedUsing:automaticallyCancelling:bufferingPolicy:)" class="dashAnchor"></a>
  760. <a class="token" href="#/s:9Alamofire14DataStreamTaskV18streamingResponses15serializedUsing23automaticallyCancelling15bufferingPolicyAA0C2OfVyAA0bC7RequestC0C0Vy_16SerializedObjectQzAA7AFErrorOGGx_SbScS12ContinuationV09BufferingL0OyAR__GtAA0bC10SerializerRzlF">streamingResponses(serializedUsing:<wbr>automaticallyCancelling:<wbr>bufferingPolicy:<wbr>)</a>
  761. </code>
  762. </div>
  763. <div class="height-container">
  764. <div class="pointer-container"></div>
  765. <section class="section">
  766. <div class="pointer"></div>
  767. <div class="abstract">
  768. <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>
  769. </div>
  770. <div class="declaration">
  771. <h4>Declaration</h4>
  772. <div class="language">
  773. <p class="aside-title">Swift</p>
  774. <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>
  775. <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>
  776. <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>
  777. <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>
  778. </div>
  779. </div>
  780. <div>
  781. <h4>Parameters</h4>
  782. <table class="graybox">
  783. <tbody>
  784. <tr>
  785. <td>
  786. <code>
  787. <em>serializer</em>
  788. </code>
  789. </td>
  790. <td>
  791. <div>
  792. <p><code><a href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a></code> to use to serialize incoming <code>Data</code>.</p>
  793. </div>
  794. </td>
  795. </tr>
  796. <tr>
  797. <td>
  798. <code>
  799. <em>shouldAutomaticallyCancel</em>
  800. </code>
  801. </td>
  802. <td>
  803. <div>
  804. <p><code>Bool</code> indicating whether the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> should be canceled
  805. which observation of the stream stops. <code>true</code> by default.</p>
  806. </div>
  807. </td>
  808. </tr>
  809. <tr>
  810. <td>
  811. <code>
  812. <em>bufferingPolicy</em>
  813. </code>
  814. </td>
  815. <td>
  816. <div>
  817. <p><code>BufferingPolicy</code> that determines the stream&rsquo;s buffering behavior.<code>.unbounded</code> by default.</p>
  818. </div>
  819. </td>
  820. </tr>
  821. </tbody>
  822. </table>
  823. </div>
  824. <div>
  825. <h4>Return Value</h4>
  826. <p>The <code><a href="../Structs/DataStreamTask.html#/s:9Alamofire14DataStreamTaskV0C0a">Stream</a></code>.</p>
  827. </div>
  828. </section>
  829. </div>
  830. </li>
  831. <li class="item">
  832. <div>
  833. <code>
  834. <a name="/s:9Alamofire14DataStreamTaskV6cancelyyF"></a>
  835. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  836. <a class="token" href="#/s:9Alamofire14DataStreamTaskV6cancelyyF">cancel()</a>
  837. </code>
  838. </div>
  839. <div class="height-container">
  840. <div class="pointer-container"></div>
  841. <section class="section">
  842. <div class="pointer"></div>
  843. <div class="abstract">
  844. <p>Cancel the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code>.</p>
  845. </div>
  846. <div class="declaration">
  847. <h4>Declaration</h4>
  848. <div class="language">
  849. <p class="aside-title">Swift</p>
  850. <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>
  851. </div>
  852. </div>
  853. </section>
  854. </div>
  855. </li>
  856. <li class="item">
  857. <div>
  858. <code>
  859. <a name="/s:9Alamofire14DataStreamTaskV6resumeyyF"></a>
  860. <a name="//apple_ref/swift/Method/resume()" class="dashAnchor"></a>
  861. <a class="token" href="#/s:9Alamofire14DataStreamTaskV6resumeyyF">resume()</a>
  862. </code>
  863. </div>
  864. <div class="height-container">
  865. <div class="pointer-container"></div>
  866. <section class="section">
  867. <div class="pointer"></div>
  868. <div class="abstract">
  869. <p>Resume the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code>.</p>
  870. </div>
  871. <div class="declaration">
  872. <h4>Declaration</h4>
  873. <div class="language">
  874. <p class="aside-title">Swift</p>
  875. <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>
  876. </div>
  877. </div>
  878. </section>
  879. </div>
  880. </li>
  881. <li class="item">
  882. <div>
  883. <code>
  884. <a name="/s:9Alamofire14DataStreamTaskV7suspendyyF"></a>
  885. <a name="//apple_ref/swift/Method/suspend()" class="dashAnchor"></a>
  886. <a class="token" href="#/s:9Alamofire14DataStreamTaskV7suspendyyF">suspend()</a>
  887. </code>
  888. </div>
  889. <div class="height-container">
  890. <div class="pointer-container"></div>
  891. <section class="section">
  892. <div class="pointer"></div>
  893. <div class="abstract">
  894. <p>Suspend the underlying <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code>.</p>
  895. </div>
  896. <div class="declaration">
  897. <h4>Declaration</h4>
  898. <div class="language">
  899. <p class="aside-title">Swift</p>
  900. <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>
  901. </div>
  902. </div>
  903. </section>
  904. </div>
  905. </li>
  906. </ul>
  907. </div>
  908. </div>
  909. </section>
  910. </article>
  911. </div>
  912. <section class="footer">
  913. <p>&copy; 2021 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2021-12-13)</p>
  914. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  915. </section>
  916. </body>
  917. </html>