Result.html 65 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140
  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:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download_6method10parameters8encoding7headers2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSg10Foundation3URLV011destinationO0_AI0H7OptionsV7optionstAT_So17NSHTTPURLResponseCtcSgtF">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:9Alamofire8download_2toAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationI0_AE0D7OptionsV7optionstAI_So17NSHTTPURLResponseCtcSgtF">download(_:to:)</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download12resumingWith2toAA15DownloadRequestC10Foundation4DataV_AG3URLV011destinationJ0_AF0F7OptionsV7optionstAK_So17NSHTTPURLResponseCtcSgtF">download(resumingWith:to:)</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestyAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7request_6method10parameters8encoding7headersAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSgtF">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:9Alamofire6stream4withAA13StreamRequestCSo12NSNetServiceC_tF">stream(with:)</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6stream12withHostName4portAA13StreamRequestCSS_SitF">stream(withHostName:port:)</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload17multipartFormData14usingThreshold2to6method7headers18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgyAA14SessionManagerC0mdE14EncodingResultOcSgtF">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:9Alamofire6upload17multipartFormData14usingThreshold4with18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA21URLRequestConvertible_pyAA14SessionManagerC0kdE14EncodingResultOcSgtF">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:9Alamofire6ResultO7successyACyxGxcAEmlF"></a>
  323. <a name="//apple_ref/swift/Element/success(_:)" class="dashAnchor"></a>
  324. <a class="token" href="#/s:9Alamofire6ResultO7successyACyxGxcAEmlF">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. <li class="item">
  345. <div>
  346. <code>
  347. <a name="/s:9Alamofire6ResultO7failureyACyxGs5Error_pcAEmlF"></a>
  348. <a name="//apple_ref/swift/Element/failure(_:)" class="dashAnchor"></a>
  349. <a class="token" href="#/s:9Alamofire6ResultO7failureyACyxGs5Error_pcAEmlF">failure(_:)</a>
  350. </code>
  351. </div>
  352. <div class="height-container">
  353. <div class="pointer-container"></div>
  354. <section class="section">
  355. <div class="pointer"></div>
  356. <div class="abstract">
  357. <p>Undocumented</p>
  358. </div>
  359. <div class="declaration">
  360. <h4>Declaration</h4>
  361. <div class="language">
  362. <p class="aside-title">Swift</p>
  363. <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>
  364. </div>
  365. </div>
  366. </section>
  367. </div>
  368. </li>
  369. <li class="item">
  370. <div>
  371. <code>
  372. <a name="/s:9Alamofire6ResultO9isSuccessSbvp"></a>
  373. <a name="//apple_ref/swift/Property/isSuccess" class="dashAnchor"></a>
  374. <a class="token" href="#/s:9Alamofire6ResultO9isSuccessSbvp">isSuccess</a>
  375. </code>
  376. </div>
  377. <div class="height-container">
  378. <div class="pointer-container"></div>
  379. <section class="section">
  380. <div class="pointer"></div>
  381. <div class="abstract">
  382. <p>Returns <code>true</code> if the result is a success, <code>false</code> otherwise.</p>
  383. </div>
  384. <div class="declaration">
  385. <h4>Declaration</h4>
  386. <div class="language">
  387. <p class="aside-title">Swift</p>
  388. <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>
  389. </div>
  390. </div>
  391. </section>
  392. </div>
  393. </li>
  394. <li class="item">
  395. <div>
  396. <code>
  397. <a name="/s:9Alamofire6ResultO9isFailureSbvp"></a>
  398. <a name="//apple_ref/swift/Property/isFailure" class="dashAnchor"></a>
  399. <a class="token" href="#/s:9Alamofire6ResultO9isFailureSbvp">isFailure</a>
  400. </code>
  401. </div>
  402. <div class="height-container">
  403. <div class="pointer-container"></div>
  404. <section class="section">
  405. <div class="pointer"></div>
  406. <div class="abstract">
  407. <p>Returns <code>true</code> if the result is a failure, <code>false</code> otherwise.</p>
  408. </div>
  409. <div class="declaration">
  410. <h4>Declaration</h4>
  411. <div class="language">
  412. <p class="aside-title">Swift</p>
  413. <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>
  414. </div>
  415. </div>
  416. </section>
  417. </div>
  418. </li>
  419. <li class="item">
  420. <div>
  421. <code>
  422. <a name="/s:9Alamofire6ResultO5valuexSgvp"></a>
  423. <a name="//apple_ref/swift/Property/value" class="dashAnchor"></a>
  424. <a class="token" href="#/s:9Alamofire6ResultO5valuexSgvp">value</a>
  425. </code>
  426. </div>
  427. <div class="height-container">
  428. <div class="pointer-container"></div>
  429. <section class="section">
  430. <div class="pointer"></div>
  431. <div class="abstract">
  432. <p>Returns the associated value if the result is a success, <code>nil</code> otherwise.</p>
  433. </div>
  434. <div class="declaration">
  435. <h4>Declaration</h4>
  436. <div class="language">
  437. <p class="aside-title">Swift</p>
  438. <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>
  439. </div>
  440. </div>
  441. </section>
  442. </div>
  443. </li>
  444. <li class="item">
  445. <div>
  446. <code>
  447. <a name="/s:9Alamofire6ResultO5errors5Error_pSgvp"></a>
  448. <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
  449. <a class="token" href="#/s:9Alamofire6ResultO5errors5Error_pSgvp">error</a>
  450. </code>
  451. </div>
  452. <div class="height-container">
  453. <div class="pointer-container"></div>
  454. <section class="section">
  455. <div class="pointer"></div>
  456. <div class="abstract">
  457. <p>Returns the associated error value if the result is a failure, <code>nil</code> otherwise.</p>
  458. </div>
  459. <div class="declaration">
  460. <h4>Declaration</h4>
  461. <div class="language">
  462. <p class="aside-title">Swift</p>
  463. <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>
  464. </div>
  465. </div>
  466. </section>
  467. </div>
  468. </li>
  469. </ul>
  470. </div>
  471. <div class="task-group">
  472. <div class="task-name-container">
  473. <a name="/CustomStringConvertible"></a>
  474. <a name="//apple_ref/swift/Section/CustomStringConvertible" class="dashAnchor"></a>
  475. <a href="#/CustomStringConvertible">
  476. <h3 class="section-name">CustomStringConvertible</h3>
  477. </a>
  478. </div>
  479. <ul class="item-container">
  480. <li class="item">
  481. <div>
  482. <code>
  483. <a name="/s:9Alamofire6ResultO11descriptionSSvp"></a>
  484. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  485. <a class="token" href="#/s:9Alamofire6ResultO11descriptionSSvp">description</a>
  486. </code>
  487. </div>
  488. <div class="height-container">
  489. <div class="pointer-container"></div>
  490. <section class="section">
  491. <div class="pointer"></div>
  492. <div class="abstract">
  493. <p>The textual representation used when written to an output stream, which includes whether the result was a
  494. success or failure.</p>
  495. </div>
  496. <div class="declaration">
  497. <h4>Declaration</h4>
  498. <div class="language">
  499. <p class="aside-title">Swift</p>
  500. <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>
  501. </div>
  502. </div>
  503. </section>
  504. </div>
  505. </li>
  506. </ul>
  507. </div>
  508. <div class="task-group">
  509. <div class="task-name-container">
  510. <a name="/CustomDebugStringConvertible"></a>
  511. <a name="//apple_ref/swift/Section/CustomDebugStringConvertible" class="dashAnchor"></a>
  512. <a href="#/CustomDebugStringConvertible">
  513. <h3 class="section-name">CustomDebugStringConvertible</h3>
  514. </a>
  515. </div>
  516. <ul class="item-container">
  517. <li class="item">
  518. <div>
  519. <code>
  520. <a name="/s:9Alamofire6ResultO16debugDescriptionSSvp"></a>
  521. <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
  522. <a class="token" href="#/s:9Alamofire6ResultO16debugDescriptionSSvp">debugDescription</a>
  523. </code>
  524. </div>
  525. <div class="height-container">
  526. <div class="pointer-container"></div>
  527. <section class="section">
  528. <div class="pointer"></div>
  529. <div class="abstract">
  530. <p>The debug textual representation used when written to an output stream, which includes whether the result was a
  531. success or failure in addition to the value or error.</p>
  532. </div>
  533. <div class="declaration">
  534. <h4>Declaration</h4>
  535. <div class="language">
  536. <p class="aside-title">Swift</p>
  537. <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>
  538. </div>
  539. </div>
  540. </section>
  541. </div>
  542. </li>
  543. </ul>
  544. </div>
  545. <div class="task-group">
  546. <div class="task-name-container">
  547. <a name="/Functional%20APIs"></a>
  548. <a name="//apple_ref/swift/Section/Functional APIs" class="dashAnchor"></a>
  549. <a href="#/Functional%20APIs">
  550. <h3 class="section-name">Functional APIs</h3>
  551. </a>
  552. </div>
  553. <ul class="item-container">
  554. <li class="item">
  555. <div>
  556. <code>
  557. <a name="/s:9Alamofire6ResultO5valueACyxGxyKXE_tcfc"></a>
  558. <a name="//apple_ref/swift/Method/init(value:)" class="dashAnchor"></a>
  559. <a class="token" href="#/s:9Alamofire6ResultO5valueACyxGxyKXE_tcfc">init(value:)</a>
  560. </code>
  561. </div>
  562. <div class="height-container">
  563. <div class="pointer-container"></div>
  564. <section class="section">
  565. <div class="pointer"></div>
  566. <div class="abstract">
  567. <p>Creates a <code>Result</code> instance from the result of a closure.</p>
  568. <p>A failure result is created when the closure throws, and a success result is created when the closure
  569. succeeds without throwing an error.</p>
  570. <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>
  571. <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>
  572. <span class="k">return</span> <span class="k">try</span> <span class="nf">someString</span><span class="p">()</span>
  573. <span class="p">})</span>
  574. <span class="c1">// The type of result is Result&lt;String&gt;</span>
  575. </code></pre>
  576. <p>The trailing closure syntax is also supported:</p>
  577. <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>
  578. </code></pre>
  579. </div>
  580. <div class="declaration">
  581. <h4>Declaration</h4>
  582. <div class="language">
  583. <p class="aside-title">Swift</p>
  584. <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>
  585. </div>
  586. </div>
  587. <div>
  588. <h4>Parameters</h4>
  589. <table class="graybox">
  590. <tbody>
  591. <tr>
  592. <td>
  593. <code>
  594. <em>value</em>
  595. </code>
  596. </td>
  597. <td>
  598. <div>
  599. <p>The closure to execute and create the result for.</p>
  600. </div>
  601. </td>
  602. </tr>
  603. </tbody>
  604. </table>
  605. </div>
  606. </section>
  607. </div>
  608. </li>
  609. <li class="item">
  610. <div>
  611. <code>
  612. <a name="/s:9Alamofire6ResultO6unwrapxyKF"></a>
  613. <a name="//apple_ref/swift/Method/unwrap()" class="dashAnchor"></a>
  614. <a class="token" href="#/s:9Alamofire6ResultO6unwrapxyKF">unwrap()</a>
  615. </code>
  616. </div>
  617. <div class="height-container">
  618. <div class="pointer-container"></div>
  619. <section class="section">
  620. <div class="pointer"></div>
  621. <div class="abstract">
  622. <p>Returns the success value, or throws the failure error.</p>
  623. <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>
  624. <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>
  625. <span class="c1">// Prints "success"</span>
  626. <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>
  627. <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>
  628. <span class="c1">// Throws error</span>
  629. </code></pre>
  630. </div>
  631. <div class="declaration">
  632. <h4>Declaration</h4>
  633. <div class="language">
  634. <p class="aside-title">Swift</p>
  635. <pre class="highlight swift"><code><span class="kd">public</span> <span class="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>
  636. </div>
  637. </div>
  638. </section>
  639. </div>
  640. </li>
  641. <li class="item">
  642. <div>
  643. <code>
  644. <a name="/s:9Alamofire6ResultO3mapyACyqd__Gqd__xXElF"></a>
  645. <a name="//apple_ref/swift/Method/map(_:)" class="dashAnchor"></a>
  646. <a class="token" href="#/s:9Alamofire6ResultO3mapyACyqd__Gqd__xXElF">map(_:)</a>
  647. </code>
  648. </div>
  649. <div class="height-container">
  650. <div class="pointer-container"></div>
  651. <section class="section">
  652. <div class="pointer"></div>
  653. <div class="abstract">
  654. <p>Evaluates the specified closure when the <code>Result</code> is a success, passing the unwrapped value as a parameter.</p>
  655. <p>Use the <code>map</code> method with a closure that does not throw. For example:</p>
  656. <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>
  657. <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>
  658. <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>
  659. <span class="c1">// Prints "0"</span>
  660. <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>
  661. <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>
  662. <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>
  663. <span class="c1">// Throws error</span>
  664. </code></pre>
  665. </div>
  666. <div class="declaration">
  667. <h4>Declaration</h4>
  668. <div class="language">
  669. <p class="aside-title">Swift</p>
  670. <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>
  671. </div>
  672. </div>
  673. <div>
  674. <h4>Parameters</h4>
  675. <table class="graybox">
  676. <tbody>
  677. <tr>
  678. <td>
  679. <code>
  680. <em>transform</em>
  681. </code>
  682. </td>
  683. <td>
  684. <div>
  685. <p>A closure that takes the success value of the <code>Result</code> instance.</p>
  686. </div>
  687. </td>
  688. </tr>
  689. </tbody>
  690. </table>
  691. </div>
  692. <div>
  693. <h4>Return Value</h4>
  694. <p>A <code>Result</code> containing the result of the given closure. If this instance is a failure, returns the
  695. same failure.</p>
  696. </div>
  697. </section>
  698. </div>
  699. </li>
  700. <li class="item">
  701. <div>
  702. <code>
  703. <a name="/s:9Alamofire6ResultO7flatMapyACyqd__Gqd__xKXElF"></a>
  704. <a name="//apple_ref/swift/Method/flatMap(_:)" class="dashAnchor"></a>
  705. <a class="token" href="#/s:9Alamofire6ResultO7flatMapyACyqd__Gqd__xKXElF">flatMap(_:)</a>
  706. </code>
  707. </div>
  708. <div class="height-container">
  709. <div class="pointer-container"></div>
  710. <section class="section">
  711. <div class="pointer"></div>
  712. <div class="abstract">
  713. <p>Evaluates the specified closure when the <code>Result</code> is a success, passing the unwrapped value as a parameter.</p>
  714. <p>Use the <code>flatMap</code> method with a closure that may throw an error. For example:</p>
  715. <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>
  716. <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>
  717. <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>
  718. <span class="p">}</span>
  719. </code></pre>
  720. </div>
  721. <div class="declaration">
  722. <h4>Declaration</h4>
  723. <div class="language">
  724. <p class="aside-title">Swift</p>
  725. <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>
  726. </div>
  727. </div>
  728. <div>
  729. <h4>Parameters</h4>
  730. <table class="graybox">
  731. <tbody>
  732. <tr>
  733. <td>
  734. <code>
  735. <em>transform</em>
  736. </code>
  737. </td>
  738. <td>
  739. <div>
  740. <p>A closure that takes the success value of the instance.</p>
  741. </div>
  742. </td>
  743. </tr>
  744. </tbody>
  745. </table>
  746. </div>
  747. <div>
  748. <h4>Return Value</h4>
  749. <p>A <code>Result</code> containing the result of the given closure. If this instance is a failure, returns the
  750. same failure.</p>
  751. </div>
  752. </section>
  753. </div>
  754. </li>
  755. <li class="item">
  756. <div>
  757. <code>
  758. <a name="/s:9Alamofire6ResultO8mapErroryACyxGqd__s0D0_pXEsAFRd__lF"></a>
  759. <a name="//apple_ref/swift/Method/mapError(_:)" class="dashAnchor"></a>
  760. <a class="token" href="#/s:9Alamofire6ResultO8mapErroryACyxGqd__s0D0_pXEsAFRd__lF">mapError(_:)</a>
  761. </code>
  762. </div>
  763. <div class="height-container">
  764. <div class="pointer-container"></div>
  765. <section class="section">
  766. <div class="pointer"></div>
  767. <div class="abstract">
  768. <p>Evaluates the specified closure when the <code>Result</code> is a failure, passing the unwrapped error as a parameter.</p>
  769. <p>Use the <code>mapError</code> function with a closure that does not throw. For example:</p>
  770. <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>
  771. <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>
  772. </code></pre>
  773. </div>
  774. <div class="declaration">
  775. <h4>Declaration</h4>
  776. <div class="language">
  777. <p class="aside-title">Swift</p>
  778. <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>
  779. </div>
  780. </div>
  781. <div>
  782. <h4>Parameters</h4>
  783. <table class="graybox">
  784. <tbody>
  785. <tr>
  786. <td>
  787. <code>
  788. <em>transform</em>
  789. </code>
  790. </td>
  791. <td>
  792. <div>
  793. <p>A closure that takes the error of the instance.</p>
  794. </div>
  795. </td>
  796. </tr>
  797. </tbody>
  798. </table>
  799. </div>
  800. <div>
  801. <h4>Return Value</h4>
  802. <p>A <code>Result</code> instance containing the result of the transform. If this instance is a success, returns
  803. the same instance.</p>
  804. </div>
  805. </section>
  806. </div>
  807. </li>
  808. <li class="item">
  809. <div>
  810. <code>
  811. <a name="/s:9Alamofire6ResultO12flatMapErroryACyxGqd__s0E0_pKXEsAFRd__lF"></a>
  812. <a name="//apple_ref/swift/Method/flatMapError(_:)" class="dashAnchor"></a>
  813. <a class="token" href="#/s:9Alamofire6ResultO12flatMapErroryACyxGqd__s0E0_pKXEsAFRd__lF">flatMapError(_:)</a>
  814. </code>
  815. </div>
  816. <div class="height-container">
  817. <div class="pointer-container"></div>
  818. <section class="section">
  819. <div class="pointer"></div>
  820. <div class="abstract">
  821. <p>Evaluates the specified closure when the <code>Result</code> is a failure, passing the unwrapped error as a parameter.</p>
  822. <p>Use the <code>flatMapError</code> function with a closure that may throw an error. For example:</p>
  823. <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>
  824. <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>
  825. <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>
  826. <span class="p">}</span>
  827. </code></pre>
  828. </div>
  829. <div class="declaration">
  830. <h4>Declaration</h4>
  831. <div class="language">
  832. <p class="aside-title">Swift</p>
  833. <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>
  834. </div>
  835. </div>
  836. <div>
  837. <h4>Parameters</h4>
  838. <table class="graybox">
  839. <tbody>
  840. <tr>
  841. <td>
  842. <code>
  843. <em>transform</em>
  844. </code>
  845. </td>
  846. <td>
  847. <div>
  848. <p>A throwing closure that takes the error of the instance.</p>
  849. </div>
  850. </td>
  851. </tr>
  852. </tbody>
  853. </table>
  854. </div>
  855. <div>
  856. <h4>Return Value</h4>
  857. <p>A <code>Result</code> instance containing the result of the transform. If this instance is a success, returns
  858. the same instance.</p>
  859. </div>
  860. </section>
  861. </div>
  862. </li>
  863. <li class="item">
  864. <div>
  865. <code>
  866. <a name="/s:9Alamofire6ResultO9withValueyACyxGyxKXEKF"></a>
  867. <a name="//apple_ref/swift/Method/withValue(_:)" class="dashAnchor"></a>
  868. <a class="token" href="#/s:9Alamofire6ResultO9withValueyACyxGyxKXEKF">withValue(_:)</a>
  869. </code>
  870. </div>
  871. <div class="height-container">
  872. <div class="pointer-container"></div>
  873. <section class="section">
  874. <div class="pointer"></div>
  875. <div class="abstract">
  876. <p>Evaluates the specified closure when the <code>Result</code> is a success, passing the unwrapped value as a parameter.</p>
  877. <p>Use the <code>withValue</code> function to evaluate the passed closure without modifying the <code>Result</code> instance.</p>
  878. </div>
  879. <div class="declaration">
  880. <h4>Declaration</h4>
  881. <div class="language">
  882. <p class="aside-title">Swift</p>
  883. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  884. <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>
  885. </div>
  886. </div>
  887. <div>
  888. <h4>Parameters</h4>
  889. <table class="graybox">
  890. <tbody>
  891. <tr>
  892. <td>
  893. <code>
  894. <em>closure</em>
  895. </code>
  896. </td>
  897. <td>
  898. <div>
  899. <p>A closure that takes the success value of this instance.</p>
  900. </div>
  901. </td>
  902. </tr>
  903. </tbody>
  904. </table>
  905. </div>
  906. <div>
  907. <h4>Return Value</h4>
  908. <p>This <code>Result</code> instance, unmodified.</p>
  909. </div>
  910. </section>
  911. </div>
  912. </li>
  913. <li class="item">
  914. <div>
  915. <code>
  916. <a name="/s:9Alamofire6ResultO9withErroryACyxGys0D0_pKXEKF"></a>
  917. <a name="//apple_ref/swift/Method/withError(_:)" class="dashAnchor"></a>
  918. <a class="token" href="#/s:9Alamofire6ResultO9withErroryACyxGys0D0_pKXEKF">withError(_:)</a>
  919. </code>
  920. </div>
  921. <div class="height-container">
  922. <div class="pointer-container"></div>
  923. <section class="section">
  924. <div class="pointer"></div>
  925. <div class="abstract">
  926. <p>Evaluates the specified closure when the <code>Result</code> is a failure, passing the unwrapped error as a parameter.</p>
  927. <p>Use the <code>withError</code> function to evaluate the passed closure without modifying the <code>Result</code> instance.</p>
  928. </div>
  929. <div class="declaration">
  930. <h4>Declaration</h4>
  931. <div class="language">
  932. <p class="aside-title">Swift</p>
  933. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  934. <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>
  935. </div>
  936. </div>
  937. <div>
  938. <h4>Parameters</h4>
  939. <table class="graybox">
  940. <tbody>
  941. <tr>
  942. <td>
  943. <code>
  944. <em>closure</em>
  945. </code>
  946. </td>
  947. <td>
  948. <div>
  949. <p>A closure that takes the success value of this instance.</p>
  950. </div>
  951. </td>
  952. </tr>
  953. </tbody>
  954. </table>
  955. </div>
  956. <div>
  957. <h4>Return Value</h4>
  958. <p>This <code>Result</code> instance, unmodified.</p>
  959. </div>
  960. </section>
  961. </div>
  962. </li>
  963. <li class="item">
  964. <div>
  965. <code>
  966. <a name="/s:9Alamofire6ResultO9ifSuccessyACyxGyyKXEKF"></a>
  967. <a name="//apple_ref/swift/Method/ifSuccess(_:)" class="dashAnchor"></a>
  968. <a class="token" href="#/s:9Alamofire6ResultO9ifSuccessyACyxGyyKXEKF">ifSuccess(_:)</a>
  969. </code>
  970. </div>
  971. <div class="height-container">
  972. <div class="pointer-container"></div>
  973. <section class="section">
  974. <div class="pointer"></div>
  975. <div class="abstract">
  976. <p>Evaluates the specified closure when the <code>Result</code> is a success.</p>
  977. <p>Use the <code>ifSuccess</code> function to evaluate the passed closure without modifying the <code>Result</code> instance.</p>
  978. </div>
  979. <div class="declaration">
  980. <h4>Declaration</h4>
  981. <div class="language">
  982. <p class="aside-title">Swift</p>
  983. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  984. <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>
  985. </div>
  986. </div>
  987. <div>
  988. <h4>Parameters</h4>
  989. <table class="graybox">
  990. <tbody>
  991. <tr>
  992. <td>
  993. <code>
  994. <em>closure</em>
  995. </code>
  996. </td>
  997. <td>
  998. <div>
  999. <p>A <code>Void</code> closure.</p>
  1000. </div>
  1001. </td>
  1002. </tr>
  1003. </tbody>
  1004. </table>
  1005. </div>
  1006. <div>
  1007. <h4>Return Value</h4>
  1008. <p>This <code>Result</code> instance, unmodified.</p>
  1009. </div>
  1010. </section>
  1011. </div>
  1012. </li>
  1013. <li class="item">
  1014. <div>
  1015. <code>
  1016. <a name="/s:9Alamofire6ResultO9ifFailureyACyxGyyKXEKF"></a>
  1017. <a name="//apple_ref/swift/Method/ifFailure(_:)" class="dashAnchor"></a>
  1018. <a class="token" href="#/s:9Alamofire6ResultO9ifFailureyACyxGyyKXEKF">ifFailure(_:)</a>
  1019. </code>
  1020. </div>
  1021. <div class="height-container">
  1022. <div class="pointer-container"></div>
  1023. <section class="section">
  1024. <div class="pointer"></div>
  1025. <div class="abstract">
  1026. <p>Evaluates the specified closure when the <code>Result</code> is a failure.</p>
  1027. <p>Use the <code>ifFailure</code> function to evaluate the passed closure without modifying the <code>Result</code> instance.</p>
  1028. </div>
  1029. <div class="declaration">
  1030. <h4>Declaration</h4>
  1031. <div class="language">
  1032. <p class="aside-title">Swift</p>
  1033. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1034. <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>
  1035. </div>
  1036. </div>
  1037. <div>
  1038. <h4>Parameters</h4>
  1039. <table class="graybox">
  1040. <tbody>
  1041. <tr>
  1042. <td>
  1043. <code>
  1044. <em>closure</em>
  1045. </code>
  1046. </td>
  1047. <td>
  1048. <div>
  1049. <p>A <code>Void</code> closure.</p>
  1050. </div>
  1051. </td>
  1052. </tr>
  1053. </tbody>
  1054. </table>
  1055. </div>
  1056. <div>
  1057. <h4>Return Value</h4>
  1058. <p>This <code>Result</code> instance, unmodified.</p>
  1059. </div>
  1060. </section>
  1061. </div>
  1062. </li>
  1063. </ul>
  1064. </div>
  1065. </div>
  1066. </section>
  1067. </article>
  1068. </div>
  1069. <section class="footer">
  1070. <p>&copy; 2018 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2018-11-24)</p>
  1071. <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>
  1072. </section>
  1073. </body>
  1074. </div>
  1075. </html>