DataResponse.html 64 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>DataResponse 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/DataResponse" class="dashAnchor"></a>
  16. <a title="DataResponse 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.4.0 Docs
  21. </a>
  22. (97% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  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"/>
  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"/>
  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" />
  45. DataResponse 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/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  248. </li>
  249. </ul>
  250. </li>
  251. <li class="nav-group-name">
  252. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  253. <ul class="nav-group-tasks">
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  307. </li>
  308. </ul>
  309. </li>
  310. <li class="nav-group-name">
  311. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  312. <ul class="nav-group-tasks">
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  384. </li>
  385. </ul>
  386. </li>
  387. <li class="nav-group-name">
  388. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  389. <ul class="nav-group-tasks">
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  464. </li>
  465. </ul>
  466. </li>
  467. <li class="nav-group-name">
  468. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  469. <ul class="nav-group-tasks">
  470. <li class="nav-group-task">
  471. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  472. </li>
  473. <li class="nav-group-task">
  474. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  475. </li>
  476. <li class="nav-group-task">
  477. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  478. </li>
  479. <li class="nav-group-task">
  480. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  481. </li>
  482. <li class="nav-group-task">
  483. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  484. </li>
  485. <li class="nav-group-task">
  486. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  487. </li>
  488. <li class="nav-group-task">
  489. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  490. </li>
  491. </ul>
  492. </li>
  493. </ul>
  494. </nav>
  495. <article class="main-content">
  496. <section class="section">
  497. <div class="section-content top-matter">
  498. <h1>DataResponse</h1>
  499. <div class="declaration">
  500. <div class="language">
  501. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">Failure</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  502. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">DataResponse</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span><span class="p">,</span> <span class="kt">CustomDebugStringConvertible</span></code></pre>
  503. </div>
  504. </div>
  505. <p>Type used to store all values associated with a serialized response of a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> or <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  506. </div>
  507. </section>
  508. <section class="section">
  509. <div class="section-content">
  510. <div class="task-group">
  511. <ul class="item-container">
  512. <li class="item">
  513. <div>
  514. <code>
  515. <a name="/s:9Alamofire12DataResponseV7request10Foundation10URLRequestVSgvp"></a>
  516. <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
  517. <a class="token" href="#/s:9Alamofire12DataResponseV7request10Foundation10URLRequestVSgvp">request</a>
  518. </code>
  519. </div>
  520. <div class="height-container">
  521. <div class="pointer-container"></div>
  522. <section class="section">
  523. <div class="pointer"></div>
  524. <div class="abstract">
  525. <p>The URL request sent to the server.</p>
  526. </div>
  527. <div class="declaration">
  528. <h4>Declaration</h4>
  529. <div class="language">
  530. <p class="aside-title">Swift</p>
  531. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?</span></code></pre>
  532. </div>
  533. </div>
  534. </section>
  535. </div>
  536. </li>
  537. <li class="item">
  538. <div>
  539. <code>
  540. <a name="/s:9Alamofire12DataResponseV8responseSo17NSHTTPURLResponseCSgvp"></a>
  541. <a name="//apple_ref/swift/Property/response" class="dashAnchor"></a>
  542. <a class="token" href="#/s:9Alamofire12DataResponseV8responseSo17NSHTTPURLResponseCSgvp">response</a>
  543. </code>
  544. </div>
  545. <div class="height-container">
  546. <div class="pointer-container"></div>
  547. <section class="section">
  548. <div class="pointer"></div>
  549. <div class="abstract">
  550. <p>The server&rsquo;s response to the URL request.</p>
  551. </div>
  552. <div class="declaration">
  553. <h4>Declaration</h4>
  554. <div class="language">
  555. <p class="aside-title">Swift</p>
  556. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">?</span></code></pre>
  557. </div>
  558. </div>
  559. </section>
  560. </div>
  561. </li>
  562. <li class="item">
  563. <div>
  564. <code>
  565. <a name="/s:9Alamofire12DataResponseV4data10Foundation0B0VSgvp"></a>
  566. <a name="//apple_ref/swift/Property/data" class="dashAnchor"></a>
  567. <a class="token" href="#/s:9Alamofire12DataResponseV4data10Foundation0B0VSgvp">data</a>
  568. </code>
  569. </div>
  570. <div class="height-container">
  571. <div class="pointer-container"></div>
  572. <section class="section">
  573. <div class="pointer"></div>
  574. <div class="abstract">
  575. <p>The data returned by the server.</p>
  576. </div>
  577. <div class="declaration">
  578. <h4>Declaration</h4>
  579. <div class="language">
  580. <p class="aside-title">Swift</p>
  581. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?</span></code></pre>
  582. </div>
  583. </div>
  584. </section>
  585. </div>
  586. </li>
  587. <li class="item">
  588. <div>
  589. <code>
  590. <a name="/s:9Alamofire12DataResponseV7metricsSo23NSURLSessionTaskMetricsCSgvp"></a>
  591. <a name="//apple_ref/swift/Property/metrics" class="dashAnchor"></a>
  592. <a class="token" href="#/s:9Alamofire12DataResponseV7metricsSo23NSURLSessionTaskMetricsCSgvp">metrics</a>
  593. </code>
  594. </div>
  595. <div class="height-container">
  596. <div class="pointer-container"></div>
  597. <section class="section">
  598. <div class="pointer"></div>
  599. <div class="abstract">
  600. <p>The final metrics of the response.</p>
  601. <div class="aside aside-note">
  602. <p class="aside-title">Note</p>
  603. Due to <code>FB7624529</code>, collection of <code>URLSessionTaskMetrics</code> on watchOS is currently disabled.`
  604. </div>
  605. </div>
  606. <div class="declaration">
  607. <h4>Declaration</h4>
  608. <div class="language">
  609. <p class="aside-title">Swift</p>
  610. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">metrics</span><span class="p">:</span> <span class="kt">URLSessionTaskMetrics</span><span class="p">?</span></code></pre>
  611. </div>
  612. </div>
  613. </section>
  614. </div>
  615. </li>
  616. <li class="item">
  617. <div>
  618. <code>
  619. <a name="/s:9Alamofire12DataResponseV21serializationDurationSdvp"></a>
  620. <a name="//apple_ref/swift/Property/serializationDuration" class="dashAnchor"></a>
  621. <a class="token" href="#/s:9Alamofire12DataResponseV21serializationDurationSdvp">serializationDuration</a>
  622. </code>
  623. </div>
  624. <div class="height-container">
  625. <div class="pointer-container"></div>
  626. <section class="section">
  627. <div class="pointer"></div>
  628. <div class="abstract">
  629. <p>The time taken to serialize the response.</p>
  630. </div>
  631. <div class="declaration">
  632. <h4>Declaration</h4>
  633. <div class="language">
  634. <p class="aside-title">Swift</p>
  635. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">serializationDuration</span><span class="p">:</span> <span class="kt">TimeInterval</span></code></pre>
  636. </div>
  637. </div>
  638. </section>
  639. </div>
  640. </li>
  641. <li class="item">
  642. <div>
  643. <code>
  644. <a name="/s:9Alamofire12DataResponseV6results6ResultOyxq_Gvp"></a>
  645. <a name="//apple_ref/swift/Property/result" class="dashAnchor"></a>
  646. <a class="token" href="#/s:9Alamofire12DataResponseV6results6ResultOyxq_Gvp">result</a>
  647. </code>
  648. </div>
  649. <div class="height-container">
  650. <div class="pointer-container"></div>
  651. <section class="section">
  652. <div class="pointer"></div>
  653. <div class="abstract">
  654. <p>The result of response serialization.</p>
  655. </div>
  656. <div class="declaration">
  657. <h4>Declaration</h4>
  658. <div class="language">
  659. <p class="aside-title">Swift</p>
  660. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">result</span><span class="p">:</span> <span class="kt">Result</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></code></pre>
  661. </div>
  662. </div>
  663. </section>
  664. </div>
  665. </li>
  666. <li class="item">
  667. <div>
  668. <code>
  669. <a name="/s:9Alamofire12DataResponseV5valuexSgvp"></a>
  670. <a name="//apple_ref/swift/Property/value" class="dashAnchor"></a>
  671. <a class="token" href="#/s:9Alamofire12DataResponseV5valuexSgvp">value</a>
  672. </code>
  673. </div>
  674. <div class="height-container">
  675. <div class="pointer-container"></div>
  676. <section class="section">
  677. <div class="pointer"></div>
  678. <div class="abstract">
  679. <p>Returns the associated value of the result if it is a success, <code>nil</code> otherwise.</p>
  680. </div>
  681. <div class="declaration">
  682. <h4>Declaration</h4>
  683. <div class="language">
  684. <p class="aside-title">Swift</p>
  685. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Success</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  686. </div>
  687. </div>
  688. </section>
  689. </div>
  690. </li>
  691. <li class="item">
  692. <div>
  693. <code>
  694. <a name="/s:9Alamofire12DataResponseV5errorq_Sgvp"></a>
  695. <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
  696. <a class="token" href="#/s:9Alamofire12DataResponseV5errorq_Sgvp">error</a>
  697. </code>
  698. </div>
  699. <div class="height-container">
  700. <div class="pointer-container"></div>
  701. <section class="section">
  702. <div class="pointer"></div>
  703. <div class="abstract">
  704. <p>Returns the associated error value if the result if it is a failure, <code>nil</code> otherwise.</p>
  705. </div>
  706. <div class="declaration">
  707. <h4>Declaration</h4>
  708. <div class="language">
  709. <p class="aside-title">Swift</p>
  710. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Failure</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  711. </div>
  712. </div>
  713. </section>
  714. </div>
  715. </li>
  716. <li class="item">
  717. <div>
  718. <code>
  719. <a name="/s:9Alamofire12DataResponseV7request8response4data7metrics21serializationDuration6resultACyxq_G10Foundation10URLRequestVSg_So17NSHTTPURLResponseCSgAK0B0VSgSo23NSURLSessionTaskMetricsCSgSds6ResultOyxq_Gtcfc"></a>
  720. <a name="//apple_ref/swift/Method/init(request:response:data:metrics:serializationDuration:result:)" class="dashAnchor"></a>
  721. <a class="token" href="#/s:9Alamofire12DataResponseV7request8response4data7metrics21serializationDuration6resultACyxq_G10Foundation10URLRequestVSg_So17NSHTTPURLResponseCSgAK0B0VSgSo23NSURLSessionTaskMetricsCSgSds6ResultOyxq_Gtcfc">init(request:<wbr>response:<wbr>data:<wbr>metrics:<wbr>serializationDuration:<wbr>result:<wbr>)</a>
  722. </code>
  723. </div>
  724. <div class="height-container">
  725. <div class="pointer-container"></div>
  726. <section class="section">
  727. <div class="pointer"></div>
  728. <div class="abstract">
  729. <p>Creates a <code>DataResponse</code> instance with the specified parameters derived from the response serialization.</p>
  730. </div>
  731. <div class="declaration">
  732. <h4>Declaration</h4>
  733. <div class="language">
  734. <p class="aside-title">Swift</p>
  735. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?,</span>
  736. <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">?,</span>
  737. <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?,</span>
  738. <span class="nv">metrics</span><span class="p">:</span> <span class="kt">URLSessionTaskMetrics</span><span class="p">?,</span>
  739. <span class="nv">serializationDuration</span><span class="p">:</span> <span class="kt">TimeInterval</span><span class="p">,</span>
  740. <span class="nv">result</span><span class="p">:</span> <span class="kt">Result</span><span class="o">&lt;</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">&gt;</span><span class="p">)</span></code></pre>
  741. </div>
  742. </div>
  743. <div>
  744. <h4>Parameters</h4>
  745. <table class="graybox">
  746. <tbody>
  747. <tr>
  748. <td>
  749. <code>
  750. <em>request</em>
  751. </code>
  752. </td>
  753. <td>
  754. <div>
  755. <p>The <code>URLRequest</code> sent to the server.</p>
  756. </div>
  757. </td>
  758. </tr>
  759. <tr>
  760. <td>
  761. <code>
  762. <em>response</em>
  763. </code>
  764. </td>
  765. <td>
  766. <div>
  767. <p>The <code>HTTPURLResponse</code> from the server.</p>
  768. </div>
  769. </td>
  770. </tr>
  771. <tr>
  772. <td>
  773. <code>
  774. <em>data</em>
  775. </code>
  776. </td>
  777. <td>
  778. <div>
  779. <p>The <code>Data</code> returned by the server.</p>
  780. </div>
  781. </td>
  782. </tr>
  783. <tr>
  784. <td>
  785. <code>
  786. <em>metrics</em>
  787. </code>
  788. </td>
  789. <td>
  790. <div>
  791. <p>The <code>URLSessionTaskMetrics</code> of the <code><a href="../Classes/DataRequest.html">DataRequest</a></code> or <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  792. </div>
  793. </td>
  794. </tr>
  795. <tr>
  796. <td>
  797. <code>
  798. <em>serializationDuration</em>
  799. </code>
  800. </td>
  801. <td>
  802. <div>
  803. <p>The duration taken by serialization.</p>
  804. </div>
  805. </td>
  806. </tr>
  807. <tr>
  808. <td>
  809. <code>
  810. <em>result</em>
  811. </code>
  812. </td>
  813. <td>
  814. <div>
  815. <p>The <code>Result</code> of response serialization.</p>
  816. </div>
  817. </td>
  818. </tr>
  819. </tbody>
  820. </table>
  821. </div>
  822. </section>
  823. </div>
  824. </li>
  825. <li class="item">
  826. <div>
  827. <code>
  828. <a name="/s:9Alamofire12DataResponseV11descriptionSSvp"></a>
  829. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  830. <a class="token" href="#/s:9Alamofire12DataResponseV11descriptionSSvp">description</a>
  831. </code>
  832. </div>
  833. <div class="height-container">
  834. <div class="pointer-container"></div>
  835. <section class="section">
  836. <div class="pointer"></div>
  837. <div class="abstract">
  838. <p>The textual representation used when written to an output stream, which includes whether the result was a
  839. success or failure.</p>
  840. </div>
  841. <div class="declaration">
  842. <h4>Declaration</h4>
  843. <div class="language">
  844. <p class="aside-title">Swift</p>
  845. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  846. </div>
  847. </div>
  848. </section>
  849. </div>
  850. </li>
  851. <li class="item">
  852. <div>
  853. <code>
  854. <a name="/s:9Alamofire12DataResponseV16debugDescriptionSSvp"></a>
  855. <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
  856. <a class="token" href="#/s:9Alamofire12DataResponseV16debugDescriptionSSvp">debugDescription</a>
  857. </code>
  858. </div>
  859. <div class="height-container">
  860. <div class="pointer-container"></div>
  861. <section class="section">
  862. <div class="pointer"></div>
  863. <div class="abstract">
  864. <p>The debug textual representation used when written to an output stream, which includes (if available) a summary
  865. of the <code>URLRequest</code>, the request&rsquo;s headers and body (if decodable as a <code>String</code> below 100KB); the
  866. <code>HTTPURLResponse</code>&lsquo;s status code, headers, and body; the duration of the network and serialization actions; and
  867. the <code>Result</code> of serialization.</p>
  868. </div>
  869. <div class="declaration">
  870. <h4>Declaration</h4>
  871. <div class="language">
  872. <p class="aside-title">Swift</p>
  873. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">debugDescription</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  874. </div>
  875. </div>
  876. </section>
  877. </div>
  878. </li>
  879. <li class="item">
  880. <div>
  881. <code>
  882. <a name="/s:9Alamofire12DataResponseV3mapyACyqd__q_Gqd__xXElF"></a>
  883. <a name="//apple_ref/swift/Method/map(_:)" class="dashAnchor"></a>
  884. <a class="token" href="#/s:9Alamofire12DataResponseV3mapyACyqd__q_Gqd__xXElF">map(_:<wbr>)</a>
  885. </code>
  886. </div>
  887. <div class="height-container">
  888. <div class="pointer-container"></div>
  889. <section class="section">
  890. <div class="pointer"></div>
  891. <div class="abstract">
  892. <p>Evaluates the specified closure when the result of this <code>DataResponse</code> is a success, passing the unwrapped
  893. result value as a parameter.</p>
  894. <p>Use the <code>map</code> method with a closure that does not throw. For example:</p>
  895. <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">possibleData</span><span class="p">:</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">...</span>
  896. <span class="k">let</span> <span class="nv">possibleInt</span> <span class="o">=</span> <span class="n">possibleData</span><span class="o">.</span><span class="n">map</span> <span class="p">{</span> <span class="nv">$0</span><span class="o">.</span><span class="n">count</span> <span class="p">}</span>
  897. </code></pre>
  898. </div>
  899. <div class="declaration">
  900. <h4>Declaration</h4>
  901. <div class="language">
  902. <p class="aside-title">Swift</p>
  903. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">map</span><span class="o">&lt;</span><span class="kt">NewSuccess</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">transform</span><span class="p">:</span> <span class="p">(</span><span class="kt">Success</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">NewSuccess</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">NewSuccess</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">&gt;</span></code></pre>
  904. </div>
  905. </div>
  906. <div>
  907. <h4>Parameters</h4>
  908. <table class="graybox">
  909. <tbody>
  910. <tr>
  911. <td>
  912. <code>
  913. <em>transform</em>
  914. </code>
  915. </td>
  916. <td>
  917. <div>
  918. <p>A closure that takes the success value of the instance&rsquo;s result.</p>
  919. </div>
  920. </td>
  921. </tr>
  922. </tbody>
  923. </table>
  924. </div>
  925. <div>
  926. <h4>Return Value</h4>
  927. <p>A <code>DataResponse</code> whose result wraps the value returned by the given closure. If this instance&rsquo;s
  928. result is a failure, returns a response wrapping the same failure.</p>
  929. </div>
  930. </section>
  931. </div>
  932. </li>
  933. <li class="item">
  934. <div>
  935. <code>
  936. <a name="/s:9Alamofire12DataResponseV6tryMapyACyqd__s5Error_pGqd__xKXElF"></a>
  937. <a name="//apple_ref/swift/Method/tryMap(_:)" class="dashAnchor"></a>
  938. <a class="token" href="#/s:9Alamofire12DataResponseV6tryMapyACyqd__s5Error_pGqd__xKXElF">tryMap(_:<wbr>)</a>
  939. </code>
  940. </div>
  941. <div class="height-container">
  942. <div class="pointer-container"></div>
  943. <section class="section">
  944. <div class="pointer"></div>
  945. <div class="abstract">
  946. <p>Evaluates the given closure when the result of this <code>DataResponse</code> is a success, passing the unwrapped result
  947. value as a parameter.</p>
  948. <p>Use the <code>tryMap</code> method with a closure that may throw an error. For example:</p>
  949. <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">possibleData</span><span class="p">:</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">...</span>
  950. <span class="k">let</span> <span class="nv">possibleObject</span> <span class="o">=</span> <span class="n">possibleData</span><span class="o">.</span><span class="n">tryMap</span> <span class="p">{</span>
  951. <span class="k">try</span> <span class="kt">JSONSerialization</span><span class="o">.</span><span class="nf">jsonObject</span><span class="p">(</span><span class="nv">with</span><span class="p">:</span> <span class="nv">$0</span><span class="p">)</span>
  952. <span class="p">}</span>
  953. </code></pre>
  954. </div>
  955. <div class="declaration">
  956. <h4>Declaration</h4>
  957. <div class="language">
  958. <p class="aside-title">Swift</p>
  959. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">tryMap</span><span class="o">&lt;</span><span class="kt">NewSuccess</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">transform</span><span class="p">:</span> <span class="p">(</span><span class="kt">Success</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">NewSuccess</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">NewSuccess</span><span class="p">,</span> <span class="kt">Error</span><span class="o">&gt;</span></code></pre>
  960. </div>
  961. </div>
  962. <div>
  963. <h4>Parameters</h4>
  964. <table class="graybox">
  965. <tbody>
  966. <tr>
  967. <td>
  968. <code>
  969. <em>transform</em>
  970. </code>
  971. </td>
  972. <td>
  973. <div>
  974. <p>A closure that takes the success value of the instance&rsquo;s result.</p>
  975. </div>
  976. </td>
  977. </tr>
  978. </tbody>
  979. </table>
  980. </div>
  981. <div>
  982. <h4>Return Value</h4>
  983. <p>A success or failure <code>DataResponse</code> depending on the result of the given closure. If this instance&rsquo;s
  984. result is a failure, returns the same failure.</p>
  985. </div>
  986. </section>
  987. </div>
  988. </li>
  989. <li class="item">
  990. <div>
  991. <code>
  992. <a name="/s:9Alamofire12DataResponseV8mapErroryACyxqd__Gqd__q_XEs0E0Rd__lF"></a>
  993. <a name="//apple_ref/swift/Method/mapError(_:)" class="dashAnchor"></a>
  994. <a class="token" href="#/s:9Alamofire12DataResponseV8mapErroryACyxqd__Gqd__q_XEs0E0Rd__lF">mapError(_:<wbr>)</a>
  995. </code>
  996. </div>
  997. <div class="height-container">
  998. <div class="pointer-container"></div>
  999. <section class="section">
  1000. <div class="pointer"></div>
  1001. <div class="abstract">
  1002. <p>Evaluates the specified closure when the <code>DataResponse</code> is a failure, passing the unwrapped error as a parameter.</p>
  1003. <p>Use the <code>mapError</code> function with a closure that does not throw. For example:</p>
  1004. <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">possibleData</span><span class="p">:</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">...</span>
  1005. <span class="k">let</span> <span class="nv">withMyError</span> <span class="o">=</span> <span class="n">possibleData</span><span class="o">.</span><span class="n">mapError</span> <span class="p">{</span> <span class="kt">MyError</span><span class="o">.</span><span class="nf">error</span><span class="p">(</span><span class="nv">$0</span><span class="p">)</span> <span class="p">}</span>
  1006. </code></pre>
  1007. </div>
  1008. <div class="declaration">
  1009. <h4>Declaration</h4>
  1010. <div class="language">
  1011. <p class="aside-title">Swift</p>
  1012. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">mapError</span><span class="o">&lt;</span><span class="kt">NewFailure</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">transform</span><span class="p">:</span> <span class="p">(</span><span class="kt">Failure</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">NewFailure</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">NewFailure</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">NewFailure</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  1013. </div>
  1014. </div>
  1015. <div>
  1016. <h4>Parameters</h4>
  1017. <table class="graybox">
  1018. <tbody>
  1019. <tr>
  1020. <td>
  1021. <code>
  1022. <em>transform</em>
  1023. </code>
  1024. </td>
  1025. <td>
  1026. <div>
  1027. <p>A closure that takes the error of the instance.</p>
  1028. </div>
  1029. </td>
  1030. </tr>
  1031. </tbody>
  1032. </table>
  1033. </div>
  1034. <div>
  1035. <h4>Return Value</h4>
  1036. <p>A <code>DataResponse</code> instance containing the result of the transform.</p>
  1037. </div>
  1038. </section>
  1039. </div>
  1040. </li>
  1041. <li class="item">
  1042. <div>
  1043. <code>
  1044. <a name="/s:9Alamofire12DataResponseV11tryMapErroryACyxs0F0_pGqd__q_KXEsAERd__lF"></a>
  1045. <a name="//apple_ref/swift/Method/tryMapError(_:)" class="dashAnchor"></a>
  1046. <a class="token" href="#/s:9Alamofire12DataResponseV11tryMapErroryACyxs0F0_pGqd__q_KXEsAERd__lF">tryMapError(_:<wbr>)</a>
  1047. </code>
  1048. </div>
  1049. <div class="height-container">
  1050. <div class="pointer-container"></div>
  1051. <section class="section">
  1052. <div class="pointer"></div>
  1053. <div class="abstract">
  1054. <p>Evaluates the specified closure when the <code>DataResponse</code> is a failure, passing the unwrapped error as a parameter.</p>
  1055. <p>Use the <code>tryMapError</code> function with a closure that may throw an error. For example:</p>
  1056. <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">possibleData</span><span class="p">:</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">...</span>
  1057. <span class="k">let</span> <span class="nv">possibleObject</span> <span class="o">=</span> <span class="n">possibleData</span><span class="o">.</span><span class="n">tryMapError</span> <span class="p">{</span>
  1058. <span class="k">try</span> <span class="nf">someFailableFunction</span><span class="p">(</span><span class="nv">taking</span><span class="p">:</span> <span class="nv">$0</span><span class="p">)</span>
  1059. <span class="p">}</span>
  1060. </code></pre>
  1061. </div>
  1062. <div class="declaration">
  1063. <h4>Declaration</h4>
  1064. <div class="language">
  1065. <p class="aside-title">Swift</p>
  1066. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">tryMapError</span><span class="o">&lt;</span><span class="kt">NewFailure</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">transform</span><span class="p">:</span> <span class="p">(</span><span class="kt">Failure</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">NewFailure</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">Error</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">NewFailure</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  1067. </div>
  1068. </div>
  1069. <div>
  1070. <h4>Parameters</h4>
  1071. <table class="graybox">
  1072. <tbody>
  1073. <tr>
  1074. <td>
  1075. <code>
  1076. <em>transform</em>
  1077. </code>
  1078. </td>
  1079. <td>
  1080. <div>
  1081. <p>A throwing closure that takes the error of the instance.</p>
  1082. </div>
  1083. </td>
  1084. </tr>
  1085. </tbody>
  1086. </table>
  1087. </div>
  1088. <div>
  1089. <h4>Return Value</h4>
  1090. <p>A <code>DataResponse</code> instance containing the result of the transform.</p>
  1091. </div>
  1092. </section>
  1093. </div>
  1094. </li>
  1095. </ul>
  1096. </div>
  1097. </div>
  1098. </section>
  1099. </article>
  1100. </div>
  1101. <section class="footer">
  1102. <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-12-20)</p>
  1103. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1104. </section>
  1105. </body>
  1106. </div>
  1107. </html>