Result.html 63 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123
  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. (86% 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/DataRequest.html">DataRequest</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/Request/ValidationResult.html">– ValidationResult</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/SessionManager.html">SessionManager</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/TaskDelegate.html">TaskDelegate</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  100. </li>
  101. </ul>
  102. </li>
  103. <li class="nav-group-name">
  104. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  105. <ul class="nav-group-tasks">
  106. <li class="nav-group-task">
  107. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  108. </li>
  109. <li class="nav-group-task">
  110. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  111. </li>
  112. <li class="nav-group-task">
  113. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  114. </li>
  115. <li class="nav-group-task">
  116. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  117. </li>
  118. <li class="nav-group-task">
  119. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  120. </li>
  121. <li class="nav-group-task">
  122. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  123. </li>
  124. <li class="nav-group-task">
  125. <a class="nav-group-task-link" href="../Enums/Result.html">Result</a>
  126. </li>
  127. <li class="nav-group-task">
  128. <a class="nav-group-task-link" href="../Enums/ServerTrustPolicy.html">ServerTrustPolicy</a>
  129. </li>
  130. </ul>
  131. </li>
  132. <li class="nav-group-name">
  133. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  134. <ul class="nav-group-tasks">
  135. <li class="nav-group-task">
  136. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  137. </li>
  138. <li class="nav-group-task">
  139. <a class="nav-group-task-link" href="../Extensions/Notification/Name.html">– Name</a>
  140. </li>
  141. <li class="nav-group-task">
  142. <a class="nav-group-task-link" href="../Extensions/Notification/Key.html">– Key</a>
  143. </li>
  144. <li class="nav-group-task">
  145. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  146. </li>
  147. <li class="nav-group-task">
  148. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  149. </li>
  150. <li class="nav-group-task">
  151. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  152. </li>
  153. <li class="nav-group-task">
  154. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  155. </li>
  156. </ul>
  157. </li>
  158. <li class="nav-group-name">
  159. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  160. <ul class="nav-group-tasks">
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF">download(_:method:parameters:encoding:headers:to:)</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF">download(_:to:)</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF">download(resumingWith:to:)</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF">request(_:method:parameters:encoding:headers:)</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF">stream(with:)</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF">stream(withHostName:port:)</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
  208. </li>
  209. </ul>
  210. </li>
  211. <li class="nav-group-name">
  212. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  213. <ul class="nav-group-tasks">
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  219. </li>
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  222. </li>
  223. <li class="nav-group-task">
  224. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  225. </li>
  226. <li class="nav-group-task">
  227. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  228. </li>
  229. <li class="nav-group-task">
  230. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  231. </li>
  232. <li class="nav-group-task">
  233. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  234. </li>
  235. </ul>
  236. </li>
  237. <li class="nav-group-name">
  238. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  239. <ul class="nav-group-tasks">
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Structs/DataResponseSerializer.html">DataResponseSerializer</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Structs/DefaultDataResponse.html">DefaultDataResponse</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  260. </li>
  261. <li class="nav-group-task">
  262. <a class="nav-group-task-link" href="../Structs/PropertyListEncoding.html">PropertyListEncoding</a>
  263. </li>
  264. <li class="nav-group-task">
  265. <a class="nav-group-task-link" href="../Structs/Timeline.html">Timeline</a>
  266. </li>
  267. <li class="nav-group-task">
  268. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  269. </li>
  270. <li class="nav-group-task">
  271. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  272. </li>
  273. <li class="nav-group-task">
  274. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  275. </li>
  276. <li class="nav-group-task">
  277. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  278. </li>
  279. </ul>
  280. </li>
  281. <li class="nav-group-name">
  282. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  283. <ul class="nav-group-tasks">
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
  292. </li>
  293. </ul>
  294. </li>
  295. </ul>
  296. </nav>
  297. <article class="main-content">
  298. <section class="section">
  299. <div class="section-content">
  300. <h1>Result</h1>
  301. <div class="declaration">
  302. <div class="language">
  303. <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>
  304. </div>
  305. </div>
  306. <p>Used to represent whether a request was successful or encountered an error.</p>
  307. <ul>
  308. <li><p>success: The request and all post processing operations were successful resulting in the serialization of the
  309. provided associated value.</p></li>
  310. <li><p>failure: The request encountered an error resulting in a failure. The associated values are the original data
  311. provided by the server as well as the error that caused the failure.</p></li>
  312. </ul>
  313. </div>
  314. </section>
  315. <section class="section">
  316. <div class="section-content">
  317. <div class="task-group">
  318. <ul class="item-container">
  319. <li class="item">
  320. <div>
  321. <code>
  322. <a name="/s:9Alamofire6ResultO7successACyxGxcAEmlF"></a>
  323. <a name="//apple_ref/swift/Element/success" class="dashAnchor"></a>
  324. <a class="token" href="#/s:9Alamofire6ResultO7successACyxGxcAEmlF">success</a>
  325. </code>
  326. </div>
  327. <div class="height-container">
  328. <div class="pointer-container"></div>
  329. <section class="section">
  330. <div class="pointer"></div>
  331. <div class="abstract">
  332. <p>Undocumented</p>
  333. </div>
  334. <div class="declaration">
  335. <h4>Declaration</h4>
  336. <div class="language">
  337. <p class="aside-title">Swift</p>
  338. <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>
  339. </div>
  340. </div>
  341. </section>
  342. </div>
  343. </li>
  344. </ul>
  345. </div>
  346. <div class="task-group">
  347. <ul class="item-container">
  348. <li class="item">
  349. <div>
  350. <code>
  351. <a name="/s:9Alamofire6ResultO7failureACyxGs5Error_pcAEmlF"></a>
  352. <a name="//apple_ref/swift/Element/failure" class="dashAnchor"></a>
  353. <a class="token" href="#/s:9Alamofire6ResultO7failureACyxGs5Error_pcAEmlF">failure</a>
  354. </code>
  355. </div>
  356. <div class="height-container">
  357. <div class="pointer-container"></div>
  358. <section class="section">
  359. <div class="pointer"></div>
  360. <div class="abstract">
  361. <p>Undocumented</p>
  362. </div>
  363. <div class="declaration">
  364. <h4>Declaration</h4>
  365. <div class="language">
  366. <p class="aside-title">Swift</p>
  367. <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>
  368. </div>
  369. </div>
  370. </section>
  371. </div>
  372. </li>
  373. </ul>
  374. </div>
  375. <div class="task-group">
  376. <ul class="item-container">
  377. <li class="item">
  378. <div>
  379. <code>
  380. <a name="/s:9Alamofire6ResultO9isSuccessSbvp"></a>
  381. <a name="//apple_ref/swift/Property/isSuccess" class="dashAnchor"></a>
  382. <a class="token" href="#/s:9Alamofire6ResultO9isSuccessSbvp">isSuccess</a>
  383. </code>
  384. </div>
  385. <div class="height-container">
  386. <div class="pointer-container"></div>
  387. <section class="section">
  388. <div class="pointer"></div>
  389. <div class="abstract">
  390. <p>Returns <code>true</code> if the result is a success, <code>false</code> otherwise.</p>
  391. </div>
  392. <div class="declaration">
  393. <h4>Declaration</h4>
  394. <div class="language">
  395. <p class="aside-title">Swift</p>
  396. <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></code></pre>
  397. </div>
  398. </div>
  399. </section>
  400. </div>
  401. </li>
  402. <li class="item">
  403. <div>
  404. <code>
  405. <a name="/s:9Alamofire6ResultO9isFailureSbvp"></a>
  406. <a name="//apple_ref/swift/Property/isFailure" class="dashAnchor"></a>
  407. <a class="token" href="#/s:9Alamofire6ResultO9isFailureSbvp">isFailure</a>
  408. </code>
  409. </div>
  410. <div class="height-container">
  411. <div class="pointer-container"></div>
  412. <section class="section">
  413. <div class="pointer"></div>
  414. <div class="abstract">
  415. <p>Returns <code>true</code> if the result is a failure, <code>false</code> otherwise.</p>
  416. </div>
  417. <div class="declaration">
  418. <h4>Declaration</h4>
  419. <div class="language">
  420. <p class="aside-title">Swift</p>
  421. <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></code></pre>
  422. </div>
  423. </div>
  424. </section>
  425. </div>
  426. </li>
  427. <li class="item">
  428. <div>
  429. <code>
  430. <a name="/s:9Alamofire6ResultO5valuexSgvp"></a>
  431. <a name="//apple_ref/swift/Property/value" class="dashAnchor"></a>
  432. <a class="token" href="#/s:9Alamofire6ResultO5valuexSgvp">value</a>
  433. </code>
  434. </div>
  435. <div class="height-container">
  436. <div class="pointer-container"></div>
  437. <section class="section">
  438. <div class="pointer"></div>
  439. <div class="abstract">
  440. <p>Returns the associated value if the result is a success, <code>nil</code> otherwise.</p>
  441. </div>
  442. <div class="declaration">
  443. <h4>Declaration</h4>
  444. <div class="language">
  445. <p class="aside-title">Swift</p>
  446. <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></code></pre>
  447. </div>
  448. </div>
  449. </section>
  450. </div>
  451. </li>
  452. <li class="item">
  453. <div>
  454. <code>
  455. <a name="/s:9Alamofire6ResultO5errors5Error_pSgvp"></a>
  456. <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
  457. <a class="token" href="#/s:9Alamofire6ResultO5errors5Error_pSgvp">error</a>
  458. </code>
  459. </div>
  460. <div class="height-container">
  461. <div class="pointer-container"></div>
  462. <section class="section">
  463. <div class="pointer"></div>
  464. <div class="abstract">
  465. <p>Returns the associated error value if the result is a failure, <code>nil</code> otherwise.</p>
  466. </div>
  467. <div class="declaration">
  468. <h4>Declaration</h4>
  469. <div class="language">
  470. <p class="aside-title">Swift</p>
  471. <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></code></pre>
  472. </div>
  473. </div>
  474. </section>
  475. </div>
  476. </li>
  477. </ul>
  478. </div>
  479. <div class="task-group">
  480. <ul class="item-container">
  481. <li class="item">
  482. <div>
  483. <code>
  484. <a name="/s:9Alamofire6ResultO11descriptionSSvp"></a>
  485. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  486. <a class="token" href="#/s:9Alamofire6ResultO11descriptionSSvp">description</a>
  487. </code>
  488. </div>
  489. <div class="height-container">
  490. <div class="pointer-container"></div>
  491. <section class="section">
  492. <div class="pointer"></div>
  493. <div class="abstract">
  494. <p>The textual representation used when written to an output stream, which includes whether the result was a
  495. success or failure.</p>
  496. </div>
  497. <div class="declaration">
  498. <h4>Declaration</h4>
  499. <div class="language">
  500. <p class="aside-title">Swift</p>
  501. <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></code></pre>
  502. </div>
  503. </div>
  504. </section>
  505. </div>
  506. </li>
  507. </ul>
  508. </div>
  509. <div class="task-group">
  510. <ul class="item-container">
  511. <li class="item">
  512. <div>
  513. <code>
  514. <a name="/s:9Alamofire6ResultO16debugDescriptionSSvp"></a>
  515. <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
  516. <a class="token" href="#/s:9Alamofire6ResultO16debugDescriptionSSvp">debugDescription</a>
  517. </code>
  518. </div>
  519. <div class="height-container">
  520. <div class="pointer-container"></div>
  521. <section class="section">
  522. <div class="pointer"></div>
  523. <div class="abstract">
  524. <p>The debug textual representation used when written to an output stream, which includes whether the result was a
  525. success or failure in addition to the value or error.</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">var</span> <span class="nv">debugDescription</span><span class="p">:</span> <span class="kt">String</span></code></pre>
  532. </div>
  533. </div>
  534. </section>
  535. </div>
  536. </li>
  537. </ul>
  538. </div>
  539. <div class="task-group">
  540. <ul class="item-container">
  541. <li class="item">
  542. <div>
  543. <code>
  544. <a name="/s:9Alamofire6ResultOACyxGxyKc5value_tcfc"></a>
  545. <a name="//apple_ref/swift/Method/init(value:)" class="dashAnchor"></a>
  546. <a class="token" href="#/s:9Alamofire6ResultOACyxGxyKc5value_tcfc">init(value:)</a>
  547. </code>
  548. </div>
  549. <div class="height-container">
  550. <div class="pointer-container"></div>
  551. <section class="section">
  552. <div class="pointer"></div>
  553. <div class="abstract">
  554. <p>Creates a <code>Result</code> instance from the result of a closure.</p>
  555. <p>A failure result is created when the closure throws, and a success result is created when the closure
  556. succeeds without throwing an error.</p>
  557. <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>
  558. <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>
  559. <span class="k">return</span> <span class="k">try</span> <span class="nf">someString</span><span class="p">()</span>
  560. <span class="p">})</span>
  561. <span class="c1">// The type of result is Result&lt;String&gt;</span>
  562. </code></pre>
  563. <p>The trailing closure syntax is also supported:</p>
  564. <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>
  565. </code></pre>
  566. </div>
  567. <div class="declaration">
  568. <h4>Declaration</h4>
  569. <div class="language">
  570. <p class="aside-title">Swift</p>
  571. <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>
  572. </div>
  573. </div>
  574. <div>
  575. <h4>Parameters</h4>
  576. <table class="graybox">
  577. <tbody>
  578. <tr>
  579. <td>
  580. <code>
  581. <em>value</em>
  582. </code>
  583. </td>
  584. <td>
  585. <div>
  586. <p>The closure to execute and create the result for.</p>
  587. </div>
  588. </td>
  589. </tr>
  590. </tbody>
  591. </table>
  592. </div>
  593. </section>
  594. </div>
  595. </li>
  596. <li class="item">
  597. <div>
  598. <code>
  599. <a name="/s:9Alamofire6ResultO6unwrapxyKF"></a>
  600. <a name="//apple_ref/swift/Method/unwrap()" class="dashAnchor"></a>
  601. <a class="token" href="#/s:9Alamofire6ResultO6unwrapxyKF">unwrap()</a>
  602. </code>
  603. </div>
  604. <div class="height-container">
  605. <div class="pointer-container"></div>
  606. <section class="section">
  607. <div class="pointer"></div>
  608. <div class="abstract">
  609. <p>Returns the success value, or throws the failure error.</p>
  610. <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>
  611. <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>
  612. <span class="c1">// Prints "success"</span>
  613. <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>
  614. <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>
  615. <span class="c1">// Throws error</span>
  616. </code></pre>
  617. </div>
  618. <div class="declaration">
  619. <h4>Declaration</h4>
  620. <div class="language">
  621. <p class="aside-title">Swift</p>
  622. <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>
  623. </div>
  624. </div>
  625. </section>
  626. </div>
  627. </li>
  628. <li class="item">
  629. <div>
  630. <code>
  631. <a name="/s:9Alamofire6ResultO3mapACyqd__Gqd__xclF"></a>
  632. <a name="//apple_ref/swift/Method/map(_:)" class="dashAnchor"></a>
  633. <a class="token" href="#/s:9Alamofire6ResultO3mapACyqd__Gqd__xclF">map(_:)</a>
  634. </code>
  635. </div>
  636. <div class="height-container">
  637. <div class="pointer-container"></div>
  638. <section class="section">
  639. <div class="pointer"></div>
  640. <div class="abstract">
  641. <p>Evaluates the specified closure when the <code>Result</code> is a success, passing the unwrapped value as a parameter.</p>
  642. <p>Use the <code>map</code> method with a closure that does not throw. For example:</p>
  643. <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>
  644. <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>
  645. <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>
  646. <span class="c1">// Prints "0"</span>
  647. <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>
  648. <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>
  649. <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>
  650. <span class="c1">// Throws error</span>
  651. </code></pre>
  652. </div>
  653. <div class="declaration">
  654. <h4>Declaration</h4>
  655. <div class="language">
  656. <p class="aside-title">Swift</p>
  657. <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>
  658. </div>
  659. </div>
  660. <div>
  661. <h4>Parameters</h4>
  662. <table class="graybox">
  663. <tbody>
  664. <tr>
  665. <td>
  666. <code>
  667. <em>transform</em>
  668. </code>
  669. </td>
  670. <td>
  671. <div>
  672. <p>A closure that takes the success value of the <code>Result</code> instance.</p>
  673. </div>
  674. </td>
  675. </tr>
  676. </tbody>
  677. </table>
  678. </div>
  679. <div>
  680. <h4>Return Value</h4>
  681. <p>A <code>Result</code> containing the result of the given closure. If this instance is a failure, returns the
  682. same failure.</p>
  683. </div>
  684. </section>
  685. </div>
  686. </li>
  687. <li class="item">
  688. <div>
  689. <code>
  690. <a name="/s:9Alamofire6ResultO7flatMapACyqd__Gqd__xKclF"></a>
  691. <a name="//apple_ref/swift/Method/flatMap(_:)" class="dashAnchor"></a>
  692. <a class="token" href="#/s:9Alamofire6ResultO7flatMapACyqd__Gqd__xKclF">flatMap(_:)</a>
  693. </code>
  694. </div>
  695. <div class="height-container">
  696. <div class="pointer-container"></div>
  697. <section class="section">
  698. <div class="pointer"></div>
  699. <div class="abstract">
  700. <p>Evaluates the specified closure when the <code>Result</code> is a success, passing the unwrapped value as a parameter.</p>
  701. <p>Use the <code>flatMap</code> method with a closure that may throw an error. For example:</p>
  702. <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>
  703. <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>
  704. <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>
  705. <span class="p">}</span>
  706. </code></pre>
  707. </div>
  708. <div class="declaration">
  709. <h4>Declaration</h4>
  710. <div class="language">
  711. <p class="aside-title">Swift</p>
  712. <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>
  713. </div>
  714. </div>
  715. <div>
  716. <h4>Parameters</h4>
  717. <table class="graybox">
  718. <tbody>
  719. <tr>
  720. <td>
  721. <code>
  722. <em>transform</em>
  723. </code>
  724. </td>
  725. <td>
  726. <div>
  727. <p>A closure that takes the success value of the instance.</p>
  728. </div>
  729. </td>
  730. </tr>
  731. </tbody>
  732. </table>
  733. </div>
  734. <div>
  735. <h4>Return Value</h4>
  736. <p>A <code>Result</code> containing the result of the given closure. If this instance is a failure, returns the
  737. same failure.</p>
  738. </div>
  739. </section>
  740. </div>
  741. </li>
  742. <li class="item">
  743. <div>
  744. <code>
  745. <a name="/s:9Alamofire6ResultO8mapErrorACyxGqd__s0D0_pcsAFRd__lF"></a>
  746. <a name="//apple_ref/swift/Method/mapError(_:)" class="dashAnchor"></a>
  747. <a class="token" href="#/s:9Alamofire6ResultO8mapErrorACyxGqd__s0D0_pcsAFRd__lF">mapError(_:)</a>
  748. </code>
  749. </div>
  750. <div class="height-container">
  751. <div class="pointer-container"></div>
  752. <section class="section">
  753. <div class="pointer"></div>
  754. <div class="abstract">
  755. <p>Evaluates the specified closure when the <code>Result</code> is a failure, passing the unwrapped error as a parameter.</p>
  756. <p>Use the <code>mapError</code> function with a closure that does not throw. For example:</p>
  757. <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>
  758. <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>
  759. </code></pre>
  760. </div>
  761. <div class="declaration">
  762. <h4>Declaration</h4>
  763. <div class="language">
  764. <p class="aside-title">Swift</p>
  765. <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="p">:</span> <span class="kt">Error</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></code></pre>
  766. </div>
  767. </div>
  768. <div>
  769. <h4>Parameters</h4>
  770. <table class="graybox">
  771. <tbody>
  772. <tr>
  773. <td>
  774. <code>
  775. <em>transform</em>
  776. </code>
  777. </td>
  778. <td>
  779. <div>
  780. <p>A closure that takes the error of the instance.</p>
  781. </div>
  782. </td>
  783. </tr>
  784. </tbody>
  785. </table>
  786. </div>
  787. <div>
  788. <h4>Return Value</h4>
  789. <p>A <code>Result</code> instance containing the result of the transform. If this instance is a success, returns
  790. the same instance.</p>
  791. </div>
  792. </section>
  793. </div>
  794. </li>
  795. <li class="item">
  796. <div>
  797. <code>
  798. <a name="/s:9Alamofire6ResultO12flatMapErrorACyxGqd__s0E0_pKcsAFRd__lF"></a>
  799. <a name="//apple_ref/swift/Method/flatMapError(_:)" class="dashAnchor"></a>
  800. <a class="token" href="#/s:9Alamofire6ResultO12flatMapErrorACyxGqd__s0E0_pKcsAFRd__lF">flatMapError(_:)</a>
  801. </code>
  802. </div>
  803. <div class="height-container">
  804. <div class="pointer-container"></div>
  805. <section class="section">
  806. <div class="pointer"></div>
  807. <div class="abstract">
  808. <p>Evaluates the specified closure when the <code>Result</code> is a failure, passing the unwrapped error as a parameter.</p>
  809. <p>Use the <code>flatMapError</code> function with a closure that may throw an error. For example:</p>
  810. <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>
  811. <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>
  812. <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>
  813. <span class="p">}</span>
  814. </code></pre>
  815. </div>
  816. <div class="declaration">
  817. <h4>Declaration</h4>
  818. <div class="language">
  819. <p class="aside-title">Swift</p>
  820. <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="p">:</span> <span class="kt">Error</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></code></pre>
  821. </div>
  822. </div>
  823. <div>
  824. <h4>Parameters</h4>
  825. <table class="graybox">
  826. <tbody>
  827. <tr>
  828. <td>
  829. <code>
  830. <em>transform</em>
  831. </code>
  832. </td>
  833. <td>
  834. <div>
  835. <p>A throwing closure that takes the error of the instance.</p>
  836. </div>
  837. </td>
  838. </tr>
  839. </tbody>
  840. </table>
  841. </div>
  842. <div>
  843. <h4>Return Value</h4>
  844. <p>A <code>Result</code> instance containing the result of the transform. If this instance is a success, returns
  845. the same instance.</p>
  846. </div>
  847. </section>
  848. </div>
  849. </li>
  850. <li class="item">
  851. <div>
  852. <code>
  853. <a name="/s:9Alamofire6ResultO9withValueACyxGyxcF"></a>
  854. <a name="//apple_ref/swift/Method/withValue(_:)" class="dashAnchor"></a>
  855. <a class="token" href="#/s:9Alamofire6ResultO9withValueACyxGyxcF">withValue(_:)</a>
  856. </code>
  857. </div>
  858. <div class="height-container">
  859. <div class="pointer-container"></div>
  860. <section class="section">
  861. <div class="pointer"></div>
  862. <div class="abstract">
  863. <p>Evaluates the specified closure when the <code>Result</code> is a success, passing the unwrapped value as a parameter.</p>
  864. <p>Use the <code>withValue</code> function to evaluate the passed closure without modifying the <code>Result</code> instance.</p>
  865. </div>
  866. <div class="declaration">
  867. <h4>Declaration</h4>
  868. <div class="language">
  869. <p class="aside-title">Swift</p>
  870. <pre class="highlight swift"><code><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="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Result</span></code></pre>
  871. </div>
  872. </div>
  873. <div>
  874. <h4>Parameters</h4>
  875. <table class="graybox">
  876. <tbody>
  877. <tr>
  878. <td>
  879. <code>
  880. <em>closure</em>
  881. </code>
  882. </td>
  883. <td>
  884. <div>
  885. <p>A closure that takes the success value of this instance.</p>
  886. </div>
  887. </td>
  888. </tr>
  889. </tbody>
  890. </table>
  891. </div>
  892. <div>
  893. <h4>Return Value</h4>
  894. <p>This <code>Result</code> instance, unmodified.</p>
  895. </div>
  896. </section>
  897. </div>
  898. </li>
  899. <li class="item">
  900. <div>
  901. <code>
  902. <a name="/s:9Alamofire6ResultO9withErrorACyxGys0D0_pcF"></a>
  903. <a name="//apple_ref/swift/Method/withError(_:)" class="dashAnchor"></a>
  904. <a class="token" href="#/s:9Alamofire6ResultO9withErrorACyxGys0D0_pcF">withError(_:)</a>
  905. </code>
  906. </div>
  907. <div class="height-container">
  908. <div class="pointer-container"></div>
  909. <section class="section">
  910. <div class="pointer"></div>
  911. <div class="abstract">
  912. <p>Evaluates the specified closure when the <code>Result</code> is a failure, passing the unwrapped error as a parameter.</p>
  913. <p>Use the <code>withError</code> function to evaluate the passed closure without modifying the <code>Result</code> instance.</p>
  914. </div>
  915. <div class="declaration">
  916. <h4>Declaration</h4>
  917. <div class="language">
  918. <p class="aside-title">Swift</p>
  919. <pre class="highlight swift"><code><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="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Result</span></code></pre>
  920. </div>
  921. </div>
  922. <div>
  923. <h4>Parameters</h4>
  924. <table class="graybox">
  925. <tbody>
  926. <tr>
  927. <td>
  928. <code>
  929. <em>closure</em>
  930. </code>
  931. </td>
  932. <td>
  933. <div>
  934. <p>A closure that takes the success value of this instance.</p>
  935. </div>
  936. </td>
  937. </tr>
  938. </tbody>
  939. </table>
  940. </div>
  941. <div>
  942. <h4>Return Value</h4>
  943. <p>This <code>Result</code> instance, unmodified.</p>
  944. </div>
  945. </section>
  946. </div>
  947. </li>
  948. <li class="item">
  949. <div>
  950. <code>
  951. <a name="/s:9Alamofire6ResultO9ifSuccessACyxGyycF"></a>
  952. <a name="//apple_ref/swift/Method/ifSuccess(_:)" class="dashAnchor"></a>
  953. <a class="token" href="#/s:9Alamofire6ResultO9ifSuccessACyxGyycF">ifSuccess(_:)</a>
  954. </code>
  955. </div>
  956. <div class="height-container">
  957. <div class="pointer-container"></div>
  958. <section class="section">
  959. <div class="pointer"></div>
  960. <div class="abstract">
  961. <p>Evaluates the specified closure when the <code>Result</code> is a success.</p>
  962. <p>Use the <code>ifSuccess</code> function to evaluate the passed closure without modifying the <code>Result</code> instance.</p>
  963. </div>
  964. <div class="declaration">
  965. <h4>Declaration</h4>
  966. <div class="language">
  967. <p class="aside-title">Swift</p>
  968. <pre class="highlight swift"><code><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="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Result</span></code></pre>
  969. </div>
  970. </div>
  971. <div>
  972. <h4>Parameters</h4>
  973. <table class="graybox">
  974. <tbody>
  975. <tr>
  976. <td>
  977. <code>
  978. <em>closure</em>
  979. </code>
  980. </td>
  981. <td>
  982. <div>
  983. <p>A <code>Void</code> closure.</p>
  984. </div>
  985. </td>
  986. </tr>
  987. </tbody>
  988. </table>
  989. </div>
  990. <div>
  991. <h4>Return Value</h4>
  992. <p>This <code>Result</code> instance, unmodified.</p>
  993. </div>
  994. </section>
  995. </div>
  996. </li>
  997. <li class="item">
  998. <div>
  999. <code>
  1000. <a name="/s:9Alamofire6ResultO9ifFailureACyxGyycF"></a>
  1001. <a name="//apple_ref/swift/Method/ifFailure(_:)" class="dashAnchor"></a>
  1002. <a class="token" href="#/s:9Alamofire6ResultO9ifFailureACyxGyycF">ifFailure(_:)</a>
  1003. </code>
  1004. </div>
  1005. <div class="height-container">
  1006. <div class="pointer-container"></div>
  1007. <section class="section">
  1008. <div class="pointer"></div>
  1009. <div class="abstract">
  1010. <p>Evaluates the specified closure when the <code>Result</code> is a failure.</p>
  1011. <p>Use the <code>ifFailure</code> function to evaluate the passed closure without modifying the <code>Result</code> instance.</p>
  1012. </div>
  1013. <div class="declaration">
  1014. <h4>Declaration</h4>
  1015. <div class="language">
  1016. <p class="aside-title">Swift</p>
  1017. <pre class="highlight swift"><code><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="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Result</span></code></pre>
  1018. </div>
  1019. </div>
  1020. <div>
  1021. <h4>Parameters</h4>
  1022. <table class="graybox">
  1023. <tbody>
  1024. <tr>
  1025. <td>
  1026. <code>
  1027. <em>closure</em>
  1028. </code>
  1029. </td>
  1030. <td>
  1031. <div>
  1032. <p>A <code>Void</code> closure.</p>
  1033. </div>
  1034. </td>
  1035. </tr>
  1036. </tbody>
  1037. </table>
  1038. </div>
  1039. <div>
  1040. <h4>Return Value</h4>
  1041. <p>This <code>Result</code> instance, unmodified.</p>
  1042. </div>
  1043. </section>
  1044. </div>
  1045. </li>
  1046. </ul>
  1047. </div>
  1048. </div>
  1049. </section>
  1050. </article>
  1051. </div>
  1052. <section class="footer">
  1053. <p>&copy; 2018 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2018-04-15)</p>
  1054. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1055. </section>
  1056. </body>
  1057. </div>
  1058. </html>