Result.html 68 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>Result Enumeration 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/Enum/Result" class="dashAnchor"></a>
  16. <a title="Result Enumeration Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire Docs
  21. </a>
  22. (75% 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%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  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. Result Enumeration 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/ClosureEventMonitor.html">ClosureEventMonitor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DisabledEvaluator.html">DisabledEvaluator</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/MultipartUpload.html">MultipartUpload</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  181. </li>
  182. </ul>
  183. </li>
  184. <li class="nav-group-name">
  185. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  186. <ul class="nav-group-tasks">
  187. <li class="nav-group-task">
  188. <a class="nav-group-task-link" href="../Enums/AF.html">AF</a>
  189. </li>
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  213. </li>
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Enums/Result.html">Result</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  219. </li>
  220. </ul>
  221. </li>
  222. <li class="nav-group-name">
  223. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  224. <ul class="nav-group-tasks">
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Extensions/Bundle.html">Bundle</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Extensions/SecTrust.html">SecTrust</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  260. </li>
  261. </ul>
  262. </li>
  263. <li class="nav-group-name">
  264. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  265. <ul class="nav-group-tasks">
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  268. </li>
  269. </ul>
  270. </li>
  271. <li class="nav-group-name">
  272. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  273. <ul class="nav-group-tasks">
  274. <li class="nav-group-task">
  275. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  276. </li>
  277. <li class="nav-group-task">
  278. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  279. </li>
  280. <li class="nav-group-task">
  281. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  282. </li>
  283. <li class="nav-group-task">
  284. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  285. </li>
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/SessionStateProvider.html">SessionStateProvider</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  333. </li>
  334. </ul>
  335. </li>
  336. <li class="nav-group-name">
  337. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  338. <ul class="nav-group-tasks">
  339. <li class="nav-group-task">
  340. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  341. </li>
  342. <li class="nav-group-task">
  343. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  344. </li>
  345. <li class="nav-group-task">
  346. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  347. </li>
  348. <li class="nav-group-task">
  349. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  350. </li>
  351. <li class="nav-group-task">
  352. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  353. </li>
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  371. </li>
  372. <li class="nav-group-task">
  373. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  374. </li>
  375. <li class="nav-group-task">
  376. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  377. </li>
  378. <li class="nav-group-task">
  379. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  380. </li>
  381. </ul>
  382. </li>
  383. <li class="nav-group-name">
  384. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  385. <ul class="nav-group-tasks">
  386. <li class="nav-group-task">
  387. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  388. </li>
  389. <li class="nav-group-task">
  390. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  391. </li>
  392. <li class="nav-group-task">
  393. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  394. </li>
  395. </ul>
  396. </li>
  397. </ul>
  398. </nav>
  399. <article class="main-content">
  400. <section class="section">
  401. <div class="section-content">
  402. <h1>Result</h1>
  403. <div class="declaration">
  404. <div class="language">
  405. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Result</span><span class="o">&lt;</span><span class="kt">Value</span><span class="o">&gt;</span></code></pre>
  406. </div>
  407. </div>
  408. <p>Used to represent whether a request was successful or encountered an error.</p>
  409. <ul>
  410. <li><p>success: The request and all post processing operations were successful resulting in the serialization of the
  411. provided associated value.</p></li>
  412. <li><p>failure: The request encountered an error resulting in a failure. The associated values are the original data
  413. provided by the server as well as the error that caused the failure.</p></li>
  414. </ul>
  415. </div>
  416. </section>
  417. <section class="section">
  418. <div class="section-content">
  419. <div class="task-group">
  420. <ul class="item-container">
  421. <li class="item">
  422. <div>
  423. <code>
  424. <a name="/s:9Alamofire6ResultO7successyACyxGxcAEmlF"></a>
  425. <a name="//apple_ref/swift/Element/success(_:)" class="dashAnchor"></a>
  426. <a class="token" href="#/s:9Alamofire6ResultO7successyACyxGxcAEmlF">success(_:)</a>
  427. </code>
  428. </div>
  429. <div class="height-container">
  430. <div class="pointer-container"></div>
  431. <section class="section">
  432. <div class="pointer"></div>
  433. <div class="abstract">
  434. <p>Undocumented</p>
  435. </div>
  436. <div class="declaration">
  437. <h4>Declaration</h4>
  438. <div class="language">
  439. <p class="aside-title">Swift</p>
  440. <pre class="highlight swift"><code><span class="k">case</span> <span class="nf">success</span><span class="p">(</span><span class="kt">Value</span><span class="p">)</span></code></pre>
  441. </div>
  442. </div>
  443. </section>
  444. </div>
  445. </li>
  446. <li class="item">
  447. <div>
  448. <code>
  449. <a name="/s:9Alamofire6ResultO7failureyACyxGs5Error_pcAEmlF"></a>
  450. <a name="//apple_ref/swift/Element/failure(_:)" class="dashAnchor"></a>
  451. <a class="token" href="#/s:9Alamofire6ResultO7failureyACyxGs5Error_pcAEmlF">failure(_:)</a>
  452. </code>
  453. </div>
  454. <div class="height-container">
  455. <div class="pointer-container"></div>
  456. <section class="section">
  457. <div class="pointer"></div>
  458. <div class="abstract">
  459. <p>Undocumented</p>
  460. </div>
  461. <div class="declaration">
  462. <h4>Declaration</h4>
  463. <div class="language">
  464. <p class="aside-title">Swift</p>
  465. <pre class="highlight swift"><code><span class="k">case</span> <span class="nf">failure</span><span class="p">(</span><span class="kt">Error</span><span class="p">)</span></code></pre>
  466. </div>
  467. </div>
  468. </section>
  469. </div>
  470. </li>
  471. <li class="item">
  472. <div>
  473. <code>
  474. <a name="/s:9Alamofire6ResultO9isSuccessSbvp"></a>
  475. <a name="//apple_ref/swift/Property/isSuccess" class="dashAnchor"></a>
  476. <a class="token" href="#/s:9Alamofire6ResultO9isSuccessSbvp">isSuccess</a>
  477. </code>
  478. </div>
  479. <div class="height-container">
  480. <div class="pointer-container"></div>
  481. <section class="section">
  482. <div class="pointer"></div>
  483. <div class="abstract">
  484. <p>Returns <code>true</code> if the result is a success, <code>false</code> otherwise.</p>
  485. </div>
  486. <div class="declaration">
  487. <h4>Declaration</h4>
  488. <div class="language">
  489. <p class="aside-title">Swift</p>
  490. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isSuccess</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  491. </div>
  492. </div>
  493. </section>
  494. </div>
  495. </li>
  496. <li class="item">
  497. <div>
  498. <code>
  499. <a name="/s:9Alamofire6ResultO9isFailureSbvp"></a>
  500. <a name="//apple_ref/swift/Property/isFailure" class="dashAnchor"></a>
  501. <a class="token" href="#/s:9Alamofire6ResultO9isFailureSbvp">isFailure</a>
  502. </code>
  503. </div>
  504. <div class="height-container">
  505. <div class="pointer-container"></div>
  506. <section class="section">
  507. <div class="pointer"></div>
  508. <div class="abstract">
  509. <p>Returns <code>true</code> if the result is a failure, <code>false</code> otherwise.</p>
  510. </div>
  511. <div class="declaration">
  512. <h4>Declaration</h4>
  513. <div class="language">
  514. <p class="aside-title">Swift</p>
  515. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isFailure</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  516. </div>
  517. </div>
  518. </section>
  519. </div>
  520. </li>
  521. <li class="item">
  522. <div>
  523. <code>
  524. <a name="/s:9Alamofire6ResultO5valuexSgvp"></a>
  525. <a name="//apple_ref/swift/Property/value" class="dashAnchor"></a>
  526. <a class="token" href="#/s:9Alamofire6ResultO5valuexSgvp">value</a>
  527. </code>
  528. </div>
  529. <div class="height-container">
  530. <div class="pointer-container"></div>
  531. <section class="section">
  532. <div class="pointer"></div>
  533. <div class="abstract">
  534. <p>Returns the associated value if the result is a success, <code>nil</code> otherwise.</p>
  535. </div>
  536. <div class="declaration">
  537. <h4>Declaration</h4>
  538. <div class="language">
  539. <p class="aside-title">Swift</p>
  540. <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">Value</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  541. </div>
  542. </div>
  543. </section>
  544. </div>
  545. </li>
  546. <li class="item">
  547. <div>
  548. <code>
  549. <a name="/s:9Alamofire6ResultO5errors5Error_pSgvp"></a>
  550. <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
  551. <a class="token" href="#/s:9Alamofire6ResultO5errors5Error_pSgvp">error</a>
  552. </code>
  553. </div>
  554. <div class="height-container">
  555. <div class="pointer-container"></div>
  556. <section class="section">
  557. <div class="pointer"></div>
  558. <div class="abstract">
  559. <p>Returns the associated error value if the result is a failure, <code>nil</code> otherwise.</p>
  560. </div>
  561. <div class="declaration">
  562. <h4>Declaration</h4>
  563. <div class="language">
  564. <p class="aside-title">Swift</p>
  565. <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">Error</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  566. </div>
  567. </div>
  568. </section>
  569. </div>
  570. </li>
  571. </ul>
  572. </div>
  573. <div class="task-group">
  574. <div class="task-name-container">
  575. <a name="/CustomStringConvertible"></a>
  576. <a name="//apple_ref/swift/Section/CustomStringConvertible" class="dashAnchor"></a>
  577. <a href="#/CustomStringConvertible">
  578. <h3 class="section-name">CustomStringConvertible</h3>
  579. </a>
  580. </div>
  581. <ul class="item-container">
  582. <li class="item">
  583. <div>
  584. <code>
  585. <a name="/s:9Alamofire6ResultO11descriptionSSvp"></a>
  586. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  587. <a class="token" href="#/s:9Alamofire6ResultO11descriptionSSvp">description</a>
  588. </code>
  589. </div>
  590. <div class="height-container">
  591. <div class="pointer-container"></div>
  592. <section class="section">
  593. <div class="pointer"></div>
  594. <div class="abstract">
  595. <p>The textual representation used when written to an output stream, which includes whether the result was a
  596. success or failure.</p>
  597. </div>
  598. <div class="declaration">
  599. <h4>Declaration</h4>
  600. <div class="language">
  601. <p class="aside-title">Swift</p>
  602. <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>
  603. </div>
  604. </div>
  605. </section>
  606. </div>
  607. </li>
  608. </ul>
  609. </div>
  610. <div class="task-group">
  611. <div class="task-name-container">
  612. <a name="/CustomDebugStringConvertible"></a>
  613. <a name="//apple_ref/swift/Section/CustomDebugStringConvertible" class="dashAnchor"></a>
  614. <a href="#/CustomDebugStringConvertible">
  615. <h3 class="section-name">CustomDebugStringConvertible</h3>
  616. </a>
  617. </div>
  618. <ul class="item-container">
  619. <li class="item">
  620. <div>
  621. <code>
  622. <a name="/s:9Alamofire6ResultO16debugDescriptionSSvp"></a>
  623. <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
  624. <a class="token" href="#/s:9Alamofire6ResultO16debugDescriptionSSvp">debugDescription</a>
  625. </code>
  626. </div>
  627. <div class="height-container">
  628. <div class="pointer-container"></div>
  629. <section class="section">
  630. <div class="pointer"></div>
  631. <div class="abstract">
  632. <p>The debug textual representation used when written to an output stream, which includes whether the result was a
  633. success or failure in addition to the value or error.</p>
  634. </div>
  635. <div class="declaration">
  636. <h4>Declaration</h4>
  637. <div class="language">
  638. <p class="aside-title">Swift</p>
  639. <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>
  640. </div>
  641. </div>
  642. </section>
  643. </div>
  644. </li>
  645. </ul>
  646. </div>
  647. <div class="task-group">
  648. <div class="task-name-container">
  649. <a name="/Functional%20APIs"></a>
  650. <a name="//apple_ref/swift/Section/Functional APIs" class="dashAnchor"></a>
  651. <a href="#/Functional%20APIs">
  652. <h3 class="section-name">Functional APIs</h3>
  653. </a>
  654. </div>
  655. <ul class="item-container">
  656. <li class="item">
  657. <div>
  658. <code>
  659. <a name="/s:9Alamofire6ResultO5valueACyxGxyKXE_tcfc"></a>
  660. <a name="//apple_ref/swift/Method/init(value:)" class="dashAnchor"></a>
  661. <a class="token" href="#/s:9Alamofire6ResultO5valueACyxGxyKXE_tcfc">init(value:)</a>
  662. </code>
  663. </div>
  664. <div class="height-container">
  665. <div class="pointer-container"></div>
  666. <section class="section">
  667. <div class="pointer"></div>
  668. <div class="abstract">
  669. <p>Creates a <code>Result</code> instance from the result of a closure.</p>
  670. <p>A failure result is created when the closure throws, and a success result is created when the closure
  671. succeeds without throwing an error.</p>
  672. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">someString</span><span class="p">()</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">String</span> <span class="p">{</span> <span class="o">...</span> <span class="p">}</span>
  673. <span class="k">let</span> <span class="nv">result</span> <span class="o">=</span> <span class="kt">Result</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="p">{</span>
  674. <span class="k">return</span> <span class="k">try</span> <span class="nf">someString</span><span class="p">()</span>
  675. <span class="p">})</span>
  676. <span class="c1">// The type of result is Result&lt;String&gt;</span>
  677. </code></pre>
  678. <p>The trailing closure syntax is also supported:</p>
  679. <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">result</span> <span class="o">=</span> <span class="kt">Result</span> <span class="p">{</span> <span class="k">try</span> <span class="nf">someString</span><span class="p">()</span> <span class="p">}</span>
  680. </code></pre>
  681. </div>
  682. <div class="declaration">
  683. <h4>Declaration</h4>
  684. <div class="language">
  685. <p class="aside-title">Swift</p>
  686. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="p">()</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">Value</span><span class="p">)</span></code></pre>
  687. </div>
  688. </div>
  689. <div>
  690. <h4>Parameters</h4>
  691. <table class="graybox">
  692. <tbody>
  693. <tr>
  694. <td>
  695. <code>
  696. <em>value</em>
  697. </code>
  698. </td>
  699. <td>
  700. <div>
  701. <p>The closure to execute and create the result for.</p>
  702. </div>
  703. </td>
  704. </tr>
  705. </tbody>
  706. </table>
  707. </div>
  708. </section>
  709. </div>
  710. </li>
  711. <li class="item">
  712. <div>
  713. <code>
  714. <a name="/s:9Alamofire6ResultO6unwrapxyKF"></a>
  715. <a name="//apple_ref/swift/Method/unwrap()" class="dashAnchor"></a>
  716. <a class="token" href="#/s:9Alamofire6ResultO6unwrapxyKF">unwrap()</a>
  717. </code>
  718. </div>
  719. <div class="height-container">
  720. <div class="pointer-container"></div>
  721. <section class="section">
  722. <div class="pointer"></div>
  723. <div class="abstract">
  724. <p>Returns the success value, or throws the failure error.</p>
  725. <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">possibleString</span><span class="p">:</span> <span class="kt">Result</span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">.</span><span class="nf">success</span><span class="p">(</span><span class="s">"success"</span><span class="p">)</span>
  726. <span class="k">try</span> <span class="nf">print</span><span class="p">(</span><span class="n">possibleString</span><span class="o">.</span><span class="nf">unwrap</span><span class="p">())</span>
  727. <span class="c1">// Prints "success"</span>
  728. <span class="k">let</span> <span class="nv">noString</span><span class="p">:</span> <span class="kt">Result</span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">.</span><span class="nf">failure</span><span class="p">(</span><span class="n">error</span><span class="p">)</span>
  729. <span class="k">try</span> <span class="nf">print</span><span class="p">(</span><span class="n">noString</span><span class="o">.</span><span class="nf">unwrap</span><span class="p">())</span>
  730. <span class="c1">// Throws error</span>
  731. </code></pre>
  732. </div>
  733. <div class="declaration">
  734. <h4>Declaration</h4>
  735. <div class="language">
  736. <p class="aside-title">Swift</p>
  737. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">unwrap</span><span class="p">()</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">Value</span></code></pre>
  738. </div>
  739. </div>
  740. </section>
  741. </div>
  742. </li>
  743. <li class="item">
  744. <div>
  745. <code>
  746. <a name="/s:9Alamofire6ResultO3mapyACyqd__Gqd__xXElF"></a>
  747. <a name="//apple_ref/swift/Method/map(_:)" class="dashAnchor"></a>
  748. <a class="token" href="#/s:9Alamofire6ResultO3mapyACyqd__Gqd__xXElF">map(_:)</a>
  749. </code>
  750. </div>
  751. <div class="height-container">
  752. <div class="pointer-container"></div>
  753. <section class="section">
  754. <div class="pointer"></div>
  755. <div class="abstract">
  756. <p>Evaluates the specified closure when the <code>Result</code> is a success, passing the unwrapped value as a parameter.</p>
  757. <p>Use the <code>map</code> method with a closure that does not throw. For example:</p>
  758. <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">possibleData</span><span class="p">:</span> <span class="kt">Result</span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">.</span><span class="nf">success</span><span class="p">(</span><span class="kt">Data</span><span class="p">())</span>
  759. <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>
  760. <span class="k">try</span> <span class="nf">print</span><span class="p">(</span><span class="n">possibleInt</span><span class="o">.</span><span class="nf">unwrap</span><span class="p">())</span>
  761. <span class="c1">// Prints "0"</span>
  762. <span class="k">let</span> <span class="nv">noData</span><span class="p">:</span> <span class="kt">Result</span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">.</span><span class="nf">failure</span><span class="p">(</span><span class="n">error</span><span class="p">)</span>
  763. <span class="k">let</span> <span class="nv">noInt</span> <span class="o">=</span> <span class="n">noData</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>
  764. <span class="k">try</span> <span class="nf">print</span><span class="p">(</span><span class="n">noInt</span><span class="o">.</span><span class="nf">unwrap</span><span class="p">())</span>
  765. <span class="c1">// Throws error</span>
  766. </code></pre>
  767. </div>
  768. <div class="declaration">
  769. <h4>Declaration</h4>
  770. <div class="language">
  771. <p class="aside-title">Swift</p>
  772. <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">T</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">Value</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Result</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span></code></pre>
  773. </div>
  774. </div>
  775. <div>
  776. <h4>Parameters</h4>
  777. <table class="graybox">
  778. <tbody>
  779. <tr>
  780. <td>
  781. <code>
  782. <em>transform</em>
  783. </code>
  784. </td>
  785. <td>
  786. <div>
  787. <p>A closure that takes the success value of the <code>Result</code> instance.</p>
  788. </div>
  789. </td>
  790. </tr>
  791. </tbody>
  792. </table>
  793. </div>
  794. <div>
  795. <h4>Return Value</h4>
  796. <p>A <code>Result</code> containing the result of the given closure. If this instance is a failure, returns the
  797. same failure.</p>
  798. </div>
  799. </section>
  800. </div>
  801. </li>
  802. <li class="item">
  803. <div>
  804. <code>
  805. <a name="/s:9Alamofire6ResultO7flatMapyACyqd__Gqd__xKXElF"></a>
  806. <a name="//apple_ref/swift/Method/flatMap(_:)" class="dashAnchor"></a>
  807. <a class="token" href="#/s:9Alamofire6ResultO7flatMapyACyqd__Gqd__xKXElF">flatMap(_:)</a>
  808. </code>
  809. </div>
  810. <div class="height-container">
  811. <div class="pointer-container"></div>
  812. <section class="section">
  813. <div class="pointer"></div>
  814. <div class="abstract">
  815. <p>Evaluates the specified closure when the <code>Result</code> is a success, passing the unwrapped value as a parameter.</p>
  816. <p>Use the <code>flatMap</code> method with a closure that may throw an error. For example:</p>
  817. <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">possibleData</span><span class="p">:</span> <span class="kt">Result</span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">.</span><span class="nf">success</span><span class="p">(</span><span class="kt">Data</span><span class="p">(</span><span class="o">...</span><span class="p">))</span>
  818. <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">flatMap</span> <span class="p">{</span>
  819. <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>
  820. <span class="p">}</span>
  821. </code></pre>
  822. </div>
  823. <div class="declaration">
  824. <h4>Declaration</h4>
  825. <div class="language">
  826. <p class="aside-title">Swift</p>
  827. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">flatMap</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">transform</span><span class="p">:</span> <span class="p">(</span><span class="kt">Value</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Result</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span></code></pre>
  828. </div>
  829. </div>
  830. <div>
  831. <h4>Parameters</h4>
  832. <table class="graybox">
  833. <tbody>
  834. <tr>
  835. <td>
  836. <code>
  837. <em>transform</em>
  838. </code>
  839. </td>
  840. <td>
  841. <div>
  842. <p>A closure that takes the success value of the instance.</p>
  843. </div>
  844. </td>
  845. </tr>
  846. </tbody>
  847. </table>
  848. </div>
  849. <div>
  850. <h4>Return Value</h4>
  851. <p>A <code>Result</code> containing the result of the given closure. If this instance is a failure, returns the
  852. same failure.</p>
  853. </div>
  854. </section>
  855. </div>
  856. </li>
  857. <li class="item">
  858. <div>
  859. <code>
  860. <a name="/s:9Alamofire6ResultO8mapErroryACyxGqd__s0D0_pXEsAFRd__lF"></a>
  861. <a name="//apple_ref/swift/Method/mapError(_:)" class="dashAnchor"></a>
  862. <a class="token" href="#/s:9Alamofire6ResultO8mapErroryACyxGqd__s0D0_pXEsAFRd__lF">mapError(_:)</a>
  863. </code>
  864. </div>
  865. <div class="height-container">
  866. <div class="pointer-container"></div>
  867. <section class="section">
  868. <div class="pointer"></div>
  869. <div class="abstract">
  870. <p>Evaluates the specified closure when the <code>Result</code> is a failure, passing the unwrapped error as a parameter.</p>
  871. <p>Use the <code>mapError</code> function with a closure that does not throw. For example:</p>
  872. <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">possibleData</span><span class="p">:</span> <span class="kt">Result</span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">.</span><span class="nf">failure</span><span class="p">(</span><span class="n">someError</span><span class="p">)</span>
  873. <span class="k">let</span> <span class="nv">withMyError</span><span class="p">:</span> <span class="kt">Result</span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</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>
  874. </code></pre>
  875. </div>
  876. <div class="declaration">
  877. <h4>Declaration</h4>
  878. <div class="language">
  879. <p class="aside-title">Swift</p>
  880. <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">T</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">Error</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Result</span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  881. </div>
  882. </div>
  883. <div>
  884. <h4>Parameters</h4>
  885. <table class="graybox">
  886. <tbody>
  887. <tr>
  888. <td>
  889. <code>
  890. <em>transform</em>
  891. </code>
  892. </td>
  893. <td>
  894. <div>
  895. <p>A closure that takes the error of the instance.</p>
  896. </div>
  897. </td>
  898. </tr>
  899. </tbody>
  900. </table>
  901. </div>
  902. <div>
  903. <h4>Return Value</h4>
  904. <p>A <code>Result</code> instance containing the result of the transform. If this instance is a success, returns
  905. the same instance.</p>
  906. </div>
  907. </section>
  908. </div>
  909. </li>
  910. <li class="item">
  911. <div>
  912. <code>
  913. <a name="/s:9Alamofire6ResultO12flatMapErroryACyxGqd__s0E0_pKXEsAFRd__lF"></a>
  914. <a name="//apple_ref/swift/Method/flatMapError(_:)" class="dashAnchor"></a>
  915. <a class="token" href="#/s:9Alamofire6ResultO12flatMapErroryACyxGqd__s0E0_pKXEsAFRd__lF">flatMapError(_:)</a>
  916. </code>
  917. </div>
  918. <div class="height-container">
  919. <div class="pointer-container"></div>
  920. <section class="section">
  921. <div class="pointer"></div>
  922. <div class="abstract">
  923. <p>Evaluates the specified closure when the <code>Result</code> is a failure, passing the unwrapped error as a parameter.</p>
  924. <p>Use the <code>flatMapError</code> function with a closure that may throw an error. For example:</p>
  925. <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">possibleData</span><span class="p">:</span> <span class="kt">Result</span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">.</span><span class="nf">success</span><span class="p">(</span><span class="kt">Data</span><span class="p">(</span><span class="o">...</span><span class="p">))</span>
  926. <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">flatMapError</span> <span class="p">{</span>
  927. <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>
  928. <span class="p">}</span>
  929. </code></pre>
  930. </div>
  931. <div class="declaration">
  932. <h4>Declaration</h4>
  933. <div class="language">
  934. <p class="aside-title">Swift</p>
  935. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">flatMapError</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">transform</span><span class="p">:</span> <span class="p">(</span><span class="kt">Error</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Result</span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  936. </div>
  937. </div>
  938. <div>
  939. <h4>Parameters</h4>
  940. <table class="graybox">
  941. <tbody>
  942. <tr>
  943. <td>
  944. <code>
  945. <em>transform</em>
  946. </code>
  947. </td>
  948. <td>
  949. <div>
  950. <p>A throwing closure that takes the error of the instance.</p>
  951. </div>
  952. </td>
  953. </tr>
  954. </tbody>
  955. </table>
  956. </div>
  957. <div>
  958. <h4>Return Value</h4>
  959. <p>A <code>Result</code> instance containing the result of the transform. If this instance is a success, returns
  960. the same instance.</p>
  961. </div>
  962. </section>
  963. </div>
  964. </li>
  965. <li class="item">
  966. <div>
  967. <code>
  968. <a name="/s:9Alamofire6ResultO9withValueyACyxGyxKXEKF"></a>
  969. <a name="//apple_ref/swift/Method/withValue(_:)" class="dashAnchor"></a>
  970. <a class="token" href="#/s:9Alamofire6ResultO9withValueyACyxGyxKXEKF">withValue(_:)</a>
  971. </code>
  972. </div>
  973. <div class="height-container">
  974. <div class="pointer-container"></div>
  975. <section class="section">
  976. <div class="pointer"></div>
  977. <div class="abstract">
  978. <p>Evaluates the specified closure when the <code>Result</code> is a success, passing the unwrapped value as a parameter.</p>
  979. <p>Use the <code>withValue</code> function to evaluate the passed closure without modifying the <code>Result</code> instance.</p>
  980. </div>
  981. <div class="declaration">
  982. <h4>Declaration</h4>
  983. <div class="language">
  984. <p class="aside-title">Swift</p>
  985. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  986. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">withValue</span><span class="p">(</span><span class="n">_</span> <span class="nv">closure</span><span class="p">:</span> <span class="p">(</span><span class="kt">Value</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="k">rethrows</span> <span class="o">-&gt;</span> <span class="kt">Result</span></code></pre>
  987. </div>
  988. </div>
  989. <div>
  990. <h4>Parameters</h4>
  991. <table class="graybox">
  992. <tbody>
  993. <tr>
  994. <td>
  995. <code>
  996. <em>closure</em>
  997. </code>
  998. </td>
  999. <td>
  1000. <div>
  1001. <p>A closure that takes the success value of this instance.</p>
  1002. </div>
  1003. </td>
  1004. </tr>
  1005. </tbody>
  1006. </table>
  1007. </div>
  1008. <div>
  1009. <h4>Return Value</h4>
  1010. <p>This <code>Result</code> instance, unmodified.</p>
  1011. </div>
  1012. </section>
  1013. </div>
  1014. </li>
  1015. <li class="item">
  1016. <div>
  1017. <code>
  1018. <a name="/s:9Alamofire6ResultO9withErroryACyxGys0D0_pKXEKF"></a>
  1019. <a name="//apple_ref/swift/Method/withError(_:)" class="dashAnchor"></a>
  1020. <a class="token" href="#/s:9Alamofire6ResultO9withErroryACyxGys0D0_pKXEKF">withError(_:)</a>
  1021. </code>
  1022. </div>
  1023. <div class="height-container">
  1024. <div class="pointer-container"></div>
  1025. <section class="section">
  1026. <div class="pointer"></div>
  1027. <div class="abstract">
  1028. <p>Evaluates the specified closure when the <code>Result</code> is a failure, passing the unwrapped error as a parameter.</p>
  1029. <p>Use the <code>withError</code> function to evaluate the passed closure without modifying the <code>Result</code> instance.</p>
  1030. </div>
  1031. <div class="declaration">
  1032. <h4>Declaration</h4>
  1033. <div class="language">
  1034. <p class="aside-title">Swift</p>
  1035. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1036. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">withError</span><span class="p">(</span><span class="n">_</span> <span class="nv">closure</span><span class="p">:</span> <span class="p">(</span><span class="kt">Error</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="k">rethrows</span> <span class="o">-&gt;</span> <span class="kt">Result</span></code></pre>
  1037. </div>
  1038. </div>
  1039. <div>
  1040. <h4>Parameters</h4>
  1041. <table class="graybox">
  1042. <tbody>
  1043. <tr>
  1044. <td>
  1045. <code>
  1046. <em>closure</em>
  1047. </code>
  1048. </td>
  1049. <td>
  1050. <div>
  1051. <p>A closure that takes the success value of this instance.</p>
  1052. </div>
  1053. </td>
  1054. </tr>
  1055. </tbody>
  1056. </table>
  1057. </div>
  1058. <div>
  1059. <h4>Return Value</h4>
  1060. <p>This <code>Result</code> instance, unmodified.</p>
  1061. </div>
  1062. </section>
  1063. </div>
  1064. </li>
  1065. <li class="item">
  1066. <div>
  1067. <code>
  1068. <a name="/s:9Alamofire6ResultO9ifSuccessyACyxGyyKXEKF"></a>
  1069. <a name="//apple_ref/swift/Method/ifSuccess(_:)" class="dashAnchor"></a>
  1070. <a class="token" href="#/s:9Alamofire6ResultO9ifSuccessyACyxGyyKXEKF">ifSuccess(_:)</a>
  1071. </code>
  1072. </div>
  1073. <div class="height-container">
  1074. <div class="pointer-container"></div>
  1075. <section class="section">
  1076. <div class="pointer"></div>
  1077. <div class="abstract">
  1078. <p>Evaluates the specified closure when the <code>Result</code> is a success.</p>
  1079. <p>Use the <code>ifSuccess</code> function to evaluate the passed closure without modifying the <code>Result</code> instance.</p>
  1080. </div>
  1081. <div class="declaration">
  1082. <h4>Declaration</h4>
  1083. <div class="language">
  1084. <p class="aside-title">Swift</p>
  1085. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1086. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">ifSuccess</span><span class="p">(</span><span class="n">_</span> <span class="nv">closure</span><span class="p">:</span> <span class="p">()</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="k">rethrows</span> <span class="o">-&gt;</span> <span class="kt">Result</span></code></pre>
  1087. </div>
  1088. </div>
  1089. <div>
  1090. <h4>Parameters</h4>
  1091. <table class="graybox">
  1092. <tbody>
  1093. <tr>
  1094. <td>
  1095. <code>
  1096. <em>closure</em>
  1097. </code>
  1098. </td>
  1099. <td>
  1100. <div>
  1101. <p>A <code>Void</code> closure.</p>
  1102. </div>
  1103. </td>
  1104. </tr>
  1105. </tbody>
  1106. </table>
  1107. </div>
  1108. <div>
  1109. <h4>Return Value</h4>
  1110. <p>This <code>Result</code> instance, unmodified.</p>
  1111. </div>
  1112. </section>
  1113. </div>
  1114. </li>
  1115. <li class="item">
  1116. <div>
  1117. <code>
  1118. <a name="/s:9Alamofire6ResultO9ifFailureyACyxGyyKXEKF"></a>
  1119. <a name="//apple_ref/swift/Method/ifFailure(_:)" class="dashAnchor"></a>
  1120. <a class="token" href="#/s:9Alamofire6ResultO9ifFailureyACyxGyyKXEKF">ifFailure(_:)</a>
  1121. </code>
  1122. </div>
  1123. <div class="height-container">
  1124. <div class="pointer-container"></div>
  1125. <section class="section">
  1126. <div class="pointer"></div>
  1127. <div class="abstract">
  1128. <p>Evaluates the specified closure when the <code>Result</code> is a failure.</p>
  1129. <p>Use the <code>ifFailure</code> function to evaluate the passed closure without modifying the <code>Result</code> instance.</p>
  1130. </div>
  1131. <div class="declaration">
  1132. <h4>Declaration</h4>
  1133. <div class="language">
  1134. <p class="aside-title">Swift</p>
  1135. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1136. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">ifFailure</span><span class="p">(</span><span class="n">_</span> <span class="nv">closure</span><span class="p">:</span> <span class="p">()</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="k">rethrows</span> <span class="o">-&gt;</span> <span class="kt">Result</span></code></pre>
  1137. </div>
  1138. </div>
  1139. <div>
  1140. <h4>Parameters</h4>
  1141. <table class="graybox">
  1142. <tbody>
  1143. <tr>
  1144. <td>
  1145. <code>
  1146. <em>closure</em>
  1147. </code>
  1148. </td>
  1149. <td>
  1150. <div>
  1151. <p>A <code>Void</code> closure.</p>
  1152. </div>
  1153. </td>
  1154. </tr>
  1155. </tbody>
  1156. </table>
  1157. </div>
  1158. <div>
  1159. <h4>Return Value</h4>
  1160. <p>This <code>Result</code> instance, unmodified.</p>
  1161. </div>
  1162. </section>
  1163. </div>
  1164. </li>
  1165. </ul>
  1166. </div>
  1167. </div>
  1168. </section>
  1169. </article>
  1170. </div>
  1171. <section class="footer">
  1172. <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-03-07)</p>
  1173. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1174. </section>
  1175. </body>
  1176. </div>
  1177. </html>