Home Explore Help
Sign In
levovix
/
Nim
mirror of https://github.com/nim-lang/Nim
Watch 1
Star 0
Fork 1
Files Issues 0 Wiki
Branch: gh-pages
Branches Tags
Nim
/
httpclient.html

httpclient.html 152 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308 
  1. <?xml version="1.0" encoding="utf-8" ?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <!--  This file is generated by Nim. -->
    4. 

  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
    5. 

  5. <head>
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    8. 

  8. <title>std/httpclient</title>
    9. 

  9. 

  10. <!-- Google fonts -->
    11. 

  11. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
    12. 

  12. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
    13. 

  13. 

  14. <!-- Favicon -->
    15. 

  15. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
    16. 

  16. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
    17. 

  17. 

  18. <!-- CSS -->
    19. 

  19. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
    20. 

  20. 

  21. <!-- JS -->
    22. 

  22. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
    23. 

  23. </head>
    24. 

  24. <body>
    25. 

  25.   <div class="document" id="documentId">
    26. 

  26.     <div class="container">
    27. 

  27.       <h1 class="title">std/httpclient</h1>
    28. 

  28.       <div class="row">
    29. 

  29.   <div class="three columns">
    30. 

  30.     <div class="theme-select-wrapper">
    31. 

  31.       <label for="theme-select">Theme:&nbsp;</label>
    32. 

  32.       <select id="theme-select" onchange="setTheme(this.value)">
    33. 

  33.         <option value="auto">🌗 Match OS</option>
    34. 

  34.         <option value="dark">🌑 Dark</option>
    35. 

  35.         <option value="light">🌕 Light</option>
    36. 

  36.       </select>
    37. 

  37.     </div>
    38. 

  38.     <div id="global-links">
    39. 

  39.       <ul class="simple-boot">
    40. 

  40.         <li><a href="manual.html">Manual</a></li>
    41. 

  41.         <li><a href="lib.html">Standard library</a></li>
    42. 

  42.         <li> <a id="indexLink" href="theindex.html">Index</a></li>
    43. 

  43.         <li><a href="compiler/theindex.html">Compiler docs</a></li>
    44. 

  44.         <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
    45. 

  45.         <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
    46. 

  46.       </ul>
    47. 

  47.     </div>
    48. 

  48.     <div id="searchInputDiv">
    49. 

  49.       Search: <input type="search" id="searchInput"
    50. 

  50.         oninput="search()" />
    51. 

  51.     </div>
    52. 

  52.     
    53. 

  53.     <ul class="simple simple-toc" id="toc-list">
    54. 

  54.   <li><a class="reference" id="retrieving-a-website_toc" href="#retrieving-a-website">Retrieving a website</a></li>
    55. 

  55. <li><a class="reference" id="using-http-post_toc" href="#using-http-post">Using HTTP POST</a></li>
    56. 

  56. <li><a class="reference" id="progress-reporting_toc" href="#progress-reporting">Progress reporting</a></li>
    57. 

  57. <li><a class="reference" id="sslslashtls-support_toc" href="#sslslashtls-support">SSL/TLS support</a></li>
    58. 

  58. <li><a class="reference" id="timeouts_toc" href="#timeouts">Timeouts</a></li>
    59. 

  59. <li><a class="reference" id="proxy_toc" href="#proxy">Proxy</a></li>
    60. 

  60. <li><a class="reference" id="redirects_toc" href="#redirects">Redirects</a></li>
    61. 

  61. <li>
    62. 

  62.   <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
    63. 

  63. </li>
    64. 

  64. <li>
    65. 

  65.   <details open>
    66. 

  66.     <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    67. 

  67.     <ul class="simple simple-toc-section">
    68. 

  68.       <li><a class="reference" href="#AsyncHttpClient" title="AsyncHttpClient = HttpClientBase[AsyncSocket]">AsyncHttpClient</a></li>
    69. 

  69. <li><a class="reference" href="#AsyncResponse" title="AsyncResponse = ref object
    70. 

  70.   version*: string
    71. 

  71.   status*: string
    72. 

  72.   headers*: HttpHeaders
    73. 

  73.   bodyStream*: FutureStream[string]">AsyncResponse</a></li>
    74. 

  74. <li><a class="reference" href="#HttpClient" title="HttpClient = HttpClientBase[Socket]">HttpClient</a></li>
    75. 

  75. <li><a class="reference" href="#HttpClientBase" title="HttpClientBase[SocketType] = ref object
    76. 

  76.   ## Where we are currently connected.
    77. 

  77.   headers*: HttpHeaders      ## Headers to send in requests.
    78. 

  78.   ## Maximum redirects, set to `0` to disable.
    79. 

  79.   timeout*: int              ## Only used for blocking HttpClient for now.
    80. 

  80.   ## `nil` or the callback to call when request progress changes.
    81. 

  81.   when SocketType is Socket:
    82. 

  82.     onProgressChanged*: ProgressChangedProc[void]
    83. 

  83.   else:
    84. 

  84.     onProgressChanged*: ProgressChangedProc[Future[void]]
    85. 

  85.   when defined(ssl):
    86. 

  86.   when SocketType is AsyncSocket:
    87. 

  87.   else:
    88. 

  88.   ## When `false`, the body is never read in requestAux.">HttpClientBase</a></li>
    89. 

  89. <li><a class="reference" href="#HttpRequestError" title="HttpRequestError = object of IOError">HttpRequestError</a></li>
    90. 

  90. <li><a class="reference" href="#MultipartData" title="MultipartData = ref object">MultipartData</a></li>
    91. 

  91. <li><a class="reference" href="#MultipartEntries" title="MultipartEntries = openArray[tuple[name, content: string]]">MultipartEntries</a></li>
    92. 

  92. <li><a class="reference" href="#ProgressChangedProc" title="ProgressChangedProc[ReturnType] = proc (total, progress, speed: BiggestInt): ReturnType {.
    93. 

  93.     closure, gcsafe.}">ProgressChangedProc</a></li>
    94. 

  94. <li><a class="reference" href="#ProtocolError" title="ProtocolError = object of IOError">ProtocolError</a></li>
    95. 

  95. <li><a class="reference" href="#Proxy" title="Proxy = ref object
    96. 

  96.   url*: Uri
    97. 

  97.   auth*: string">Proxy</a></li>
    98. 

  98. <li><a class="reference" href="#Response" title="Response = ref object
    99. 

  99.   version*: string
    100. 

  100.   status*: string
    101. 

  101.   headers*: HttpHeaders
    102. 

  102.   bodyStream*: Stream">Response</a></li>
    103. 

  103. 

  104.     </ul>
    105. 

  105.   </details>
    106. 

  106. </li>
    107. 

  107. <li>
    108. 

  108.   <details open>
    109. 

  109.     <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
    110. 

  110.     <ul class="simple simple-toc-section">
    111. 

  111.       <li><a class="reference" href="#defUserAgent" title="defUserAgent = &quot;Nim-httpclient/2.3.1&quot;">defUserAgent</a></li>
    112. 

  112. 

  113.     </ul>
    114. 

  114.   </details>
    115. 

  115. </li>
    116. 

  116. <li>
    117. 

  117.   <details open>
    118. 

  118.     <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    119. 

  119.     <ul class="simple simple-toc-section">
    120. 

  120.       <ul class="simple nested-toc-section">$
    121. 

  121.   <li><a class="reference" href="#%24%2CMultipartData" title="`$`(data: MultipartData): string">`$`(data: MultipartData): string</a></li>
    122. 

  122. 

  123. </ul>
    124. 

  124. <ul class="simple nested-toc-section">[]=
    125. 

  125.   <li><a class="reference" href="#%5B%5D%3D%2CMultipartData%2Cstring%2Cstring" title="`[]=`(p: MultipartData; name, content: string)">`[]=`(p: MultipartData; name, content: string)</a></li>
    126. 

  126. <li><a class="reference" href="#%5B%5D%3D%2CMultipartData%2Cstring%2Ctuple%5Bstring%2Cstring%2Cstring%5D" title="`[]=`(p: MultipartData; name: string;
    127. 

  127.       file: tuple[name, contentType, content: string])">`[]=`(p: MultipartData; name: string;
    128. 

  128.       file: tuple[name, contentType, content: string])</a></li>
    129. 

  129. 

  130. </ul>
    131. 

  131. <ul class="simple nested-toc-section">add
    132. 

  132.   <li><a class="reference" href="#add%2CMultipartData%2Cstring%2Cstring%2Cstring%2Cstring" title="add(p: MultipartData; name, content: string; filename: string = &quot;&quot;;
    133. 

  133.     contentType: string = &quot;&quot;; useStream = true)">add(p: MultipartData; name, content: string; filename: string = &quot;&quot;;
    134. 

  134.     contentType: string = &quot;&quot;; useStream = true)</a></li>
    135. 

  135. <li><a class="reference" href="#add%2CMultipartData%2CMultipartEntries" title="add(p: MultipartData; xs: MultipartEntries): MultipartData">add(p: MultipartData; xs: MultipartEntries): MultipartData</a></li>
    136. 

  136. 

  137. </ul>
    138. 

  138. <ul class="simple nested-toc-section">addFiles
    139. 

  139.   <li><a class="reference" href="#addFiles%2CMultipartData%2CopenArray%5Btuple%5Bstring%2Cstring%5D%5D" title="addFiles(p: MultipartData; xs: openArray[tuple[name, file: string]];
    140. 

  140.          mimeDb = newMimetypes(); useStream = true): MultipartData">addFiles(p: MultipartData; xs: openArray[tuple[name, file: string]];
    141. 

  141.          mimeDb = newMimetypes(); useStream = true): MultipartData</a></li>
    142. 

  142. 

  143. </ul>
    144. 

  144. <ul class="simple nested-toc-section">body
    145. 

  145.   <li><a class="reference" href="#body%2CAsyncResponse" title="body(response: AsyncResponse): Future[string]">body(response: AsyncResponse): Future[string]</a></li>
    146. 

  146. <li><a class="reference" href="#body%2CResponse" title="body(response: Response): string">body(response: Response): string</a></li>
    147. 

  147. 

  148. </ul>
    149. 

  149. <ul class="simple nested-toc-section">close
    150. 

  150.   <li><a class="reference" href="#close" title="close(client: HttpClient | AsyncHttpClient)">close(client: HttpClient | AsyncHttpClient)</a></li>
    151. 

  151. 

  152. </ul>
    153. 

  153. <ul class="simple nested-toc-section">code
    154. 

  154.   <li><a class="reference" href="#code" title="code(response: Response | AsyncResponse): HttpCode">code(response: Response | AsyncResponse): HttpCode</a></li>
    155. 

  155. 

  156. </ul>
    157. 

  157. <ul class="simple nested-toc-section">contentLength
    158. 

  158.   <li><a class="reference" href="#contentLength" title="contentLength(response: Response | AsyncResponse): int">contentLength(response: Response | AsyncResponse): int</a></li>
    159. 

  159. 

  160. </ul>
    161. 

  161. <ul class="simple nested-toc-section">contentType
    162. 

  162.   <li><a class="reference" href="#contentType" title="contentType(response: Response | AsyncResponse): string">contentType(response: Response | AsyncResponse): string</a></li>
    163. 

  163. 

  164. </ul>
    165. 

  165. <ul class="simple nested-toc-section">delete
    166. 

  166.   <li><a class="reference" href="#delete%2CAsyncHttpClient%2C" title="delete(client: AsyncHttpClient; url: Uri | string): Future[AsyncResponse]">delete(client: AsyncHttpClient; url: Uri | string): Future[AsyncResponse]</a></li>
    167. 

  167. <li><a class="reference" href="#delete%2CHttpClient%2C" title="delete(client: HttpClient; url: Uri | string): Response">delete(client: HttpClient; url: Uri | string): Response</a></li>
    168. 

  168. 

  169. </ul>
    170. 

  170. <ul class="simple nested-toc-section">deleteContent
    171. 

  171.   <li><a class="reference" href="#deleteContent%2CAsyncHttpClient%2C" title="deleteContent(client: AsyncHttpClient; url: Uri | string): Future[string]">deleteContent(client: AsyncHttpClient; url: Uri | string): Future[string]</a></li>
    172. 

  172. <li><a class="reference" href="#deleteContent%2CHttpClient%2C" title="deleteContent(client: HttpClient; url: Uri | string): string">deleteContent(client: HttpClient; url: Uri | string): string</a></li>
    173. 

  173. 

  174. </ul>
    175. 

  175. <ul class="simple nested-toc-section">downloadFile
    176. 

  176.   <li><a class="reference" href="#downloadFile%2CAsyncHttpClient%2C%2Cstring" title="downloadFile(client: AsyncHttpClient; url: Uri | string; filename: string): Future[
    177. 

  177.     void]">downloadFile(client: AsyncHttpClient; url: Uri | string; filename: string): Future[
    178. 

  178.     void]</a></li>
    179. 

  179. <li><a class="reference" href="#downloadFile%2CHttpClient%2C%2Cstring" title="downloadFile(client: HttpClient; url: Uri | string; filename: string)">downloadFile(client: HttpClient; url: Uri | string; filename: string)</a></li>
    180. 

  180. 

  181. </ul>
    182. 

  182. <ul class="simple nested-toc-section">get
    183. 

  183.   <li><a class="reference" href="#get%2CAsyncHttpClient%2C" title="get(client: AsyncHttpClient; url: Uri | string): Future[AsyncResponse]">get(client: AsyncHttpClient; url: Uri | string): Future[AsyncResponse]</a></li>
    184. 

  184. <li><a class="reference" href="#get%2CHttpClient%2C" title="get(client: HttpClient; url: Uri | string): Response">get(client: HttpClient; url: Uri | string): Response</a></li>
    185. 

  185. 

  186. </ul>
    187. 

  187. <ul class="simple nested-toc-section">getContent
    188. 

  188.   <li><a class="reference" href="#getContent%2CAsyncHttpClient%2C" title="getContent(client: AsyncHttpClient; url: Uri | string): Future[string]">getContent(client: AsyncHttpClient; url: Uri | string): Future[string]</a></li>
    189. 

  189. <li><a class="reference" href="#getContent%2CHttpClient%2C" title="getContent(client: HttpClient; url: Uri | string): string">getContent(client: HttpClient; url: Uri | string): string</a></li>
    190. 

  190. 

  191. </ul>
    192. 

  192. <ul class="simple nested-toc-section">getSocket
    193. 

  193.   <li><a class="reference" href="#getSocket%2CAsyncHttpClient" title="getSocket(client: AsyncHttpClient): AsyncSocket">getSocket(client: AsyncHttpClient): AsyncSocket</a></li>
    194. 

  194. <li><a class="reference" href="#getSocket%2CHttpClient" title="getSocket(client: HttpClient): Socket">getSocket(client: HttpClient): Socket</a></li>
    195. 

  195. 

  196. </ul>
    197. 

  197. <ul class="simple nested-toc-section">head
    198. 

  198.   <li><a class="reference" href="#head%2CAsyncHttpClient%2C" title="head(client: AsyncHttpClient; url: Uri | string): Future[AsyncResponse]">head(client: AsyncHttpClient; url: Uri | string): Future[AsyncResponse]</a></li>
    199. 

  199. <li><a class="reference" href="#head%2CHttpClient%2C" title="head(client: HttpClient; url: Uri | string): Response">head(client: HttpClient; url: Uri | string): Response</a></li>
    200. 

  200. 

  201. </ul>
    202. 

  202. <ul class="simple nested-toc-section">lastModified
    203. 

  203.   <li><a class="reference" href="#lastModified" title="lastModified(response: Response | AsyncResponse): DateTime">lastModified(response: Response | AsyncResponse): DateTime</a></li>
    204. 

  204. 

  205. </ul>
    206. 

  206. <ul class="simple nested-toc-section">newAsyncHttpClient
    207. 

  207.   <li><a class="reference" href="#newAsyncHttpClient%2Cint%2CProxy" title="newAsyncHttpClient(userAgent = defUserAgent; maxRedirects = 5;
    208. 

  208.                    sslContext = getDefaultSSL(); proxy: Proxy = nil;
    209. 

  209.                    headers = newHttpHeaders()): AsyncHttpClient">newAsyncHttpClient(userAgent = defUserAgent; maxRedirects = 5;
    210. 

  210.                    sslContext = getDefaultSSL(); proxy: Proxy = nil;
    211. 

  211.                    headers = newHttpHeaders()): AsyncHttpClient</a></li>
    212. 

  212. 

  213. </ul>
    214. 

  214. <ul class="simple nested-toc-section">newHttpClient
    215. 

  215.   <li><a class="reference" href="#newHttpClient%2Cint%2CProxy%2Cint" title="newHttpClient(userAgent = defUserAgent; maxRedirects = 5;
    216. 

  216.               sslContext = getDefaultSSL(); proxy: Proxy = nil; timeout = -1;
    217. 

  217.               headers = newHttpHeaders()): HttpClient">newHttpClient(userAgent = defUserAgent; maxRedirects = 5;
    218. 

  218.               sslContext = getDefaultSSL(); proxy: Proxy = nil; timeout = -1;
    219. 

  219.               headers = newHttpHeaders()): HttpClient</a></li>
    220. 

  220. 

  221. </ul>
    222. 

  222. <ul class="simple nested-toc-section">newMultipartData
    223. 

  223.   <li><a class="reference" href="#newMultipartData" title="newMultipartData(): MultipartData">newMultipartData(): MultipartData</a></li>
    224. 

  224. <li><a class="reference" href="#newMultipartData%2CMultipartEntries" title="newMultipartData(xs: MultipartEntries): MultipartData">newMultipartData(xs: MultipartEntries): MultipartData</a></li>
    225. 

  225. 

  226. </ul>
    227. 

  227. <ul class="simple nested-toc-section">newProxy
    228. 

  228.   <li><a class="reference" href="#newProxy%2Cstring%2Cstring" title="newProxy(url: string; auth = &quot;&quot;): Proxy">newProxy(url: string; auth = &quot;&quot;): Proxy</a></li>
    229. 

  229. <li><a class="reference" href="#newProxy%2CUri%2Cstring" title="newProxy(url: Uri; auth = &quot;&quot;): Proxy">newProxy(url: Uri; auth = &quot;&quot;): Proxy</a></li>
    230. 

  230. 

  231. </ul>
    232. 

  232. <ul class="simple nested-toc-section">patch
    233. 

  233.   <li><a class="reference" href="#patch%2CAsyncHttpClient%2C%2Cstring%2CMultipartData" title="patch(client: AsyncHttpClient; url: Uri | string; body = &quot;&quot;;
    234. 

  234.       multipart: MultipartData = nil): Future[AsyncResponse]">patch(client: AsyncHttpClient; url: Uri | string; body = &quot;&quot;;
    235. 

  235.       multipart: MultipartData = nil): Future[AsyncResponse]</a></li>
    236. 

  236. <li><a class="reference" href="#patch%2CHttpClient%2C%2Cstring%2CMultipartData" title="patch(client: HttpClient; url: Uri | string; body = &quot;&quot;;
    237. 

  237.       multipart: MultipartData = nil): Response">patch(client: HttpClient; url: Uri | string; body = &quot;&quot;;
    238. 

  238.       multipart: MultipartData = nil): Response</a></li>
    239. 

  239. 

  240. </ul>
    241. 

  241. <ul class="simple nested-toc-section">patchContent
    242. 

  242.   <li><a class="reference" href="#patchContent%2CAsyncHttpClient%2C%2Cstring%2CMultipartData" title="patchContent(client: AsyncHttpClient; url: Uri | string; body = &quot;&quot;;
    243. 

  243.              multipart: MultipartData = nil): Future[string]">patchContent(client: AsyncHttpClient; url: Uri | string; body = &quot;&quot;;
    244. 

  244.              multipart: MultipartData = nil): Future[string]</a></li>
    245. 

  245. <li><a class="reference" href="#patchContent%2CHttpClient%2C%2Cstring%2CMultipartData" title="patchContent(client: HttpClient; url: Uri | string; body = &quot;&quot;;
    246. 

  246.              multipart: MultipartData = nil): string">patchContent(client: HttpClient; url: Uri | string; body = &quot;&quot;;
    247. 

  247.              multipart: MultipartData = nil): string</a></li>
    248. 

  248. 

  249. </ul>
    250. 

  250. <ul class="simple nested-toc-section">post
    251. 

  251.   <li><a class="reference" href="#post%2CAsyncHttpClient%2C%2Cstring%2CMultipartData" title="post(client: AsyncHttpClient; url: Uri | string; body = &quot;&quot;;
    252. 

  252.      multipart: MultipartData = nil): Future[AsyncResponse]">post(client: AsyncHttpClient; url: Uri | string; body = &quot;&quot;;
    253. 

  253.      multipart: MultipartData = nil): Future[AsyncResponse]</a></li>
    254. 

  254. <li><a class="reference" href="#post%2CHttpClient%2C%2Cstring%2CMultipartData" title="post(client: HttpClient; url: Uri | string; body = &quot;&quot;;
    255. 

  255.      multipart: MultipartData = nil): Response">post(client: HttpClient; url: Uri | string; body = &quot;&quot;;
    256. 

  256.      multipart: MultipartData = nil): Response</a></li>
    257. 

  257. 

  258. </ul>
    259. 

  259. <ul class="simple nested-toc-section">postContent
    260. 

  260.   <li><a class="reference" href="#postContent%2CAsyncHttpClient%2C%2Cstring%2CMultipartData" title="postContent(client: AsyncHttpClient; url: Uri | string; body = &quot;&quot;;
    261. 

  261.             multipart: MultipartData = nil): Future[string]">postContent(client: AsyncHttpClient; url: Uri | string; body = &quot;&quot;;
    262. 

  262.             multipart: MultipartData = nil): Future[string]</a></li>
    263. 

  263. <li><a class="reference" href="#postContent%2CHttpClient%2C%2Cstring%2CMultipartData" title="postContent(client: HttpClient; url: Uri | string; body = &quot;&quot;;
    264. 

  264.             multipart: MultipartData = nil): string">postContent(client: HttpClient; url: Uri | string; body = &quot;&quot;;
    265. 

  265.             multipart: MultipartData = nil): string</a></li>
    266. 

  266. 

  267. </ul>
    268. 

  268. <ul class="simple nested-toc-section">put
    269. 

  269.   <li><a class="reference" href="#put%2CAsyncHttpClient%2C%2Cstring%2CMultipartData" title="put(client: AsyncHttpClient; url: Uri | string; body = &quot;&quot;;
    270. 

  270.     multipart: MultipartData = nil): Future[AsyncResponse]">put(client: AsyncHttpClient; url: Uri | string; body = &quot;&quot;;
    271. 

  271.     multipart: MultipartData = nil): Future[AsyncResponse]</a></li>
    272. 

  272. <li><a class="reference" href="#put%2CHttpClient%2C%2Cstring%2CMultipartData" title="put(client: HttpClient; url: Uri | string; body = &quot;&quot;;
    273. 

  273.     multipart: MultipartData = nil): Response">put(client: HttpClient; url: Uri | string; body = &quot;&quot;;
    274. 

  274.     multipart: MultipartData = nil): Response</a></li>
    275. 

  275. 

  276. </ul>
    277. 

  277. <ul class="simple nested-toc-section">putContent
    278. 

  278.   <li><a class="reference" href="#putContent%2CAsyncHttpClient%2C%2Cstring%2CMultipartData" title="putContent(client: AsyncHttpClient; url: Uri | string; body = &quot;&quot;;
    279. 

  279.            multipart: MultipartData = nil): Future[string]">putContent(client: AsyncHttpClient; url: Uri | string; body = &quot;&quot;;
    280. 

  280.            multipart: MultipartData = nil): Future[string]</a></li>
    281. 

  281. <li><a class="reference" href="#putContent%2CHttpClient%2C%2Cstring%2CMultipartData" title="putContent(client: HttpClient; url: Uri | string; body = &quot;&quot;;
    282. 

  282.            multipart: MultipartData = nil): string">putContent(client: HttpClient; url: Uri | string; body = &quot;&quot;;
    283. 

  283.            multipart: MultipartData = nil): string</a></li>
    284. 

  284. 

  285. </ul>
    286. 

  286. <ul class="simple nested-toc-section">request
    287. 

  287.   <li><a class="reference" href="#request%2CAsyncHttpClient%2C%2Cstring%2CHttpHeaders%2CMultipartData" title="request(client: AsyncHttpClient; url: Uri | string;
    288. 

  288.         httpMethod: HttpMethod | string = HttpGet; body = &quot;&quot;;
    289. 

  289.         headers: HttpHeaders = nil; multipart: MultipartData = nil): Future[
    290. 

  290.     AsyncResponse]">request(client: AsyncHttpClient; url: Uri | string;
    291. 

  291.         httpMethod: HttpMethod | string = HttpGet; body = &quot;&quot;;
    292. 

  292.         headers: HttpHeaders = nil; multipart: MultipartData = nil): Future[
    293. 

  293.     AsyncResponse]</a></li>
    294. 

  294. <li><a class="reference" href="#request%2CHttpClient%2C%2Cstring%2CHttpHeaders%2CMultipartData" title="request(client: HttpClient; url: Uri | string;
    295. 

  295.         httpMethod: HttpMethod | string = HttpGet; body = &quot;&quot;;
    296. 

  296.         headers: HttpHeaders = nil; multipart: MultipartData = nil): Response">request(client: HttpClient; url: Uri | string;
    297. 

  297.         httpMethod: HttpMethod | string = HttpGet; body = &quot;&quot;;
    298. 

  298.         headers: HttpHeaders = nil; multipart: MultipartData = nil): Response</a></li>
    299. 

  299. 

  300. </ul>
    301. 

  301. 

  302.     </ul>
    303. 

  303.   </details>
    304. 

  304. </li>
    305. 

  305. 

  306. </ul>
    307. 

  307. 

  308.   </div>
    309. 

  309.   <div class="nine columns" id="content">
    310. 

  310.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    311. 

  311. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    312. 

  312. 

  313.     <div id="tocRoot"></div>
    314. 

  314.     
    315. 

  315.     <p class="module-desc">This module implements a simple HTTP client that can be used to retrieve webpages and other data.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    316. 

  316. Validate untrusted inputs: URI parsers and getters are not detecting malicious URIs.</div>
    317. 

  317. 

  318. <h1><a class="toc-backref" id="retrieving-a-website" href="#retrieving-a-website">Retrieving a website</a></h1><p>This example uses HTTP GET to retrieve <tt class="docutils literal"><span class="pre"><span class="Identifier">http</span><span class="Punctuation">:</span><span class="Operator">//</span><span class="Identifier">google</span><span class="Operator">.</span><span class="Identifier">com</span></span></tt>:</p>
    319. 

  319. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">httpclient</span>
    320. 

  320. <span class="Keyword">var</span> <span class="Identifier">client</span> <span class="Operator">=</span> <span class="Identifier">newHttpClient</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    321. 

  321. <span class="Keyword">try</span><span class="Punctuation">:</span>
    322. 

  322.   <span class="Identifier">echo</span> <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">getContent</span><span class="Punctuation">(</span><span class="StringLit">&quot;http://google.com&quot;</span><span class="Punctuation">)</span>
    323. 

  323. <span class="Keyword">finally</span><span class="Punctuation">:</span>
    324. 

  324.   <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    325. 

  325. <p>The same action can also be performed asynchronously, simply use the <tt class="docutils literal"><span class="pre"><span class="Identifier">AsyncHttpClient</span></span></tt>:</p>
    326. 

  326. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Punctuation">[</span><span class="Identifier">asyncdispatch</span><span class="Punctuation">,</span> <span class="Identifier">httpclient</span><span class="Punctuation">]</span>
    327. 

  327. 

  328. <span class="Keyword">proc</span> <span class="Identifier">asyncProc</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">Future</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">async</span><span class="Operator">.</span><span class="Punctuation">}</span> <span class="Operator">=</span>
    329. 

  329.   <span class="Keyword">var</span> <span class="Identifier">client</span> <span class="Operator">=</span> <span class="Identifier">newAsyncHttpClient</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    330. 

  330.   <span class="Keyword">try</span><span class="Punctuation">:</span>
    331. 

  331.     <span class="Keyword">return</span> <span class="Identifier">await</span> <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">getContent</span><span class="Punctuation">(</span><span class="StringLit">&quot;http://google.com&quot;</span><span class="Punctuation">)</span>
    332. 

  332.   <span class="Keyword">finally</span><span class="Punctuation">:</span>
    333. 

  333.     <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    334. 

  334. 

  335. <span class="Identifier">echo</span> <span class="Identifier">waitFor</span> <span class="Identifier">asyncProc</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    336. 

  336. <p>The functionality implemented by <tt class="docutils literal"><span class="pre"><span class="Identifier">HttpClient</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">AsyncHttpClient</span></span></tt> is the same, so you can use whichever one suits you best in the examples shown here.</p>
    337. 

  337. <p><strong>Note:</strong> You need to run asynchronous examples in an async proc otherwise you will get an <tt class="docutils literal"><span class="pre"><span class="Identifier">Undeclared</span> <span class="Identifier">identifier</span><span class="Punctuation">:</span> <span class="CharLit">'await'</span></span></tt> error.</p>
    338. 

  338. <p><strong>Note:</strong> An asynchronous client instance can only deal with one request at a time. To send multiple requests in parallel, use multiple client instances.</p>
    339. 

  339. 

  340. <h1><a class="toc-backref" id="using-http-post" href="#using-http-post">Using HTTP POST</a></h1><p>This example demonstrates the usage of the W3 HTML Validator, it uses <tt class="docutils literal"><span class="pre"><span class="Identifier">multipart</span><span class="Operator">/</span><span class="Identifier">form</span><span class="Operator">-</span><span class="Identifier">data</span></span></tt> as the <tt class="docutils literal"><span class="pre"><span class="Identifier">Content</span><span class="Operator">-</span><span class="Keyword">Type</span></span></tt> to send the HTML to be validated to the server.</p>
    341. 

  341. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Punctuation">[</span><span class="Identifier">httpclient</span><span class="Punctuation">]</span>
    342. 

  342. <span class="Keyword">var</span> <span class="Identifier">client</span> <span class="Operator">=</span> <span class="Identifier">newHttpClient</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    343. 

  343. <span class="Keyword">var</span> <span class="Identifier">data</span> <span class="Operator">=</span> <span class="Identifier">newMultipartData</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    344. 

  344. <span class="Identifier">data</span><span class="Punctuation">[</span><span class="StringLit">&quot;output&quot;</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="StringLit">&quot;soap12&quot;</span>
    345. 

  345. <span class="Identifier">data</span><span class="Punctuation">[</span><span class="StringLit">&quot;uploaded_file&quot;</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Punctuation">(</span><span class="StringLit">&quot;test.html&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;text/html&quot;</span><span class="Punctuation">,</span>
    346. 

  346.   <span class="StringLit">&quot;&lt;html&gt;&lt;head&gt;&lt;/head&gt;&lt;body&gt;&lt;p&gt;test&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;&quot;</span><span class="Punctuation">)</span>
    347. 

  347. <span class="Keyword">try</span><span class="Punctuation">:</span>
    348. 

  348.   <span class="Identifier">echo</span> <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">postContent</span><span class="Punctuation">(</span><span class="StringLit">&quot;http://validator.w3.org/check&quot;</span><span class="Punctuation">,</span> <span class="Identifier">multipart</span><span class="Operator">=</span><span class="Identifier">data</span><span class="Punctuation">)</span>
    349. 

  349. <span class="Keyword">finally</span><span class="Punctuation">:</span>
    350. 

  350.   <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    351. 

  351. <p>To stream files from disk when performing the request, use <tt class="docutils literal"><span class="pre"><span class="Identifier">addFiles</span></span></tt>.</p>
    352. 

  352. <p><strong>Note:</strong> This will allocate a new <tt class="docutils literal"><span class="pre"><span class="Identifier">Mimetypes</span></span></tt> database every time you call it, you can pass your own via the <tt class="docutils literal"><span class="pre"><span class="Identifier">mimeDb</span></span></tt> parameter to avoid this.</p>
    353. 

  353. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Punctuation">[</span><span class="Identifier">httpclient</span><span class="Punctuation">,</span> <span class="Identifier">mimetypes</span><span class="Punctuation">]</span>
    354. 

  354. <span class="Keyword">let</span> <span class="Identifier">mimes</span> <span class="Operator">=</span> <span class="Identifier">newMimetypes</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    355. 

  355. <span class="Keyword">var</span> <span class="Identifier">client</span> <span class="Operator">=</span> <span class="Identifier">newHttpClient</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    356. 

  356. <span class="Keyword">var</span> <span class="Identifier">data</span> <span class="Operator">=</span> <span class="Identifier">newMultipartData</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    357. 

  357. <span class="Identifier">data</span><span class="Operator">.</span><span class="Identifier">addFiles</span><span class="Punctuation">(</span><span class="Punctuation">{</span><span class="StringLit">&quot;uploaded_file&quot;</span><span class="Punctuation">:</span> <span class="StringLit">&quot;test.html&quot;</span><span class="Punctuation">}</span><span class="Punctuation">,</span> <span class="Identifier">mimeDb</span> <span class="Operator">=</span> <span class="Identifier">mimes</span><span class="Punctuation">)</span>
    358. 

  358. <span class="Keyword">try</span><span class="Punctuation">:</span>
    359. 

  359.   <span class="Identifier">echo</span> <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">postContent</span><span class="Punctuation">(</span><span class="StringLit">&quot;http://validator.w3.org/check&quot;</span><span class="Punctuation">,</span> <span class="Identifier">multipart</span><span class="Operator">=</span><span class="Identifier">data</span><span class="Punctuation">)</span>
    360. 

  360. <span class="Keyword">finally</span><span class="Punctuation">:</span>
    361. 

  361.   <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    362. 

  362. <p>You can also make post requests with custom headers. This example sets <tt class="docutils literal"><span class="pre"><span class="Identifier">Content</span><span class="Operator">-</span><span class="Keyword">Type</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">application</span><span class="Operator">/</span><span class="Identifier">json</span></span></tt> and uses a json object for the body</p>
    363. 

  363. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Punctuation">[</span><span class="Identifier">httpclient</span><span class="Punctuation">,</span> <span class="Identifier">json</span><span class="Punctuation">]</span>
    364. 

  364. 

  365. <span class="Keyword">let</span> <span class="Identifier">client</span> <span class="Operator">=</span> <span class="Identifier">newHttpClient</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    366. 

  366. <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">headers</span> <span class="Operator">=</span> <span class="Identifier">newHttpHeaders</span><span class="Punctuation">(</span><span class="Punctuation">{</span> <span class="StringLit">&quot;Content-Type&quot;</span><span class="Punctuation">:</span> <span class="StringLit">&quot;application/json&quot;</span> <span class="Punctuation">}</span><span class="Punctuation">)</span>
    367. 

  367. <span class="Keyword">let</span> <span class="Identifier">body</span> <span class="Operator">=</span> <span class="Operator">%*</span><span class="Punctuation">{</span>
    368. 

  368.     <span class="StringLit">&quot;data&quot;</span><span class="Punctuation">:</span> <span class="StringLit">&quot;some text&quot;</span>
    369. 

  369. <span class="Punctuation">}</span>
    370. 

  370. <span class="Keyword">try</span><span class="Punctuation">:</span>
    371. 

  371.   <span class="Keyword">let</span> <span class="Identifier">response</span> <span class="Operator">=</span> <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">request</span><span class="Punctuation">(</span><span class="StringLit">&quot;http://some.api&quot;</span><span class="Punctuation">,</span> <span class="Identifier">httpMethod</span> <span class="Operator">=</span> <span class="Identifier">HttpPost</span><span class="Punctuation">,</span> <span class="Identifier">body</span> <span class="Operator">=</span> <span class="Operator">$</span><span class="Identifier">body</span><span class="Punctuation">)</span>
    372. 

  372.   <span class="Identifier">echo</span> <span class="Identifier">response</span><span class="Operator">.</span><span class="Identifier">status</span>
    373. 

  373. <span class="Keyword">finally</span><span class="Punctuation">:</span>
    374. 

  374.   <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    375. 

  375. 

  376. <h1><a class="toc-backref" id="progress-reporting" href="#progress-reporting">Progress reporting</a></h1><p>You may specify a callback procedure to be called during an HTTP request. This callback will be executed every second with information about the progress of the HTTP request.</p>
    377. 

  377. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Punctuation">[</span><span class="Identifier">asyncdispatch</span><span class="Punctuation">,</span> <span class="Identifier">httpclient</span><span class="Punctuation">]</span>
    378. 

  378. 

  379. <span class="Keyword">proc</span> <span class="Identifier">onProgressChanged</span><span class="Punctuation">(</span><span class="Identifier">total</span><span class="Punctuation">,</span> <span class="Identifier">progress</span><span class="Punctuation">,</span> <span class="Identifier">speed</span><span class="Punctuation">:</span> <span class="Identifier">BiggestInt</span><span class="Punctuation">)</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">async</span><span class="Operator">.</span><span class="Punctuation">}</span> <span class="Operator">=</span>
    380. 

  380.   <span class="Identifier">echo</span><span class="Punctuation">(</span><span class="StringLit">&quot;Downloaded &quot;</span><span class="Punctuation">,</span> <span class="Identifier">progress</span><span class="Punctuation">,</span> <span class="StringLit">&quot; of &quot;</span><span class="Punctuation">,</span> <span class="Identifier">total</span><span class="Punctuation">)</span>
    381. 

  381.   <span class="Identifier">echo</span><span class="Punctuation">(</span><span class="StringLit">&quot;Current rate: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">speed</span> <span class="Keyword">div</span> <span class="DecNumber">1000</span><span class="Punctuation">,</span> <span class="StringLit">&quot;kb/s&quot;</span><span class="Punctuation">)</span>
    382. 

  382. 

  383. <span class="Keyword">proc</span> <span class="Identifier">asyncProc</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">async</span><span class="Operator">.</span><span class="Punctuation">}</span> <span class="Operator">=</span>
    384. 

  384.   <span class="Keyword">var</span> <span class="Identifier">client</span> <span class="Operator">=</span> <span class="Identifier">newAsyncHttpClient</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    385. 

  385.   <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">onProgressChanged</span> <span class="Operator">=</span> <span class="Identifier">onProgressChanged</span>
    386. 

  386.   <span class="Keyword">try</span><span class="Punctuation">:</span>
    387. 

  387.     <span class="Keyword">discard</span> <span class="Identifier">await</span> <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">getContent</span><span class="Punctuation">(</span><span class="StringLit">&quot;http://speedtest-ams2.digitalocean.com/100mb.test&quot;</span><span class="Punctuation">)</span>
    388. 

  388.   <span class="Keyword">finally</span><span class="Punctuation">:</span>
    389. 

  389.     <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    390. 

  390. 

  391. <span class="Identifier">waitFor</span> <span class="Identifier">asyncProc</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    392. 

  392. <p>If you would like to remove the callback simply set it to <tt class="docutils literal"><span class="pre"><span class="Keyword">nil</span></span></tt>.</p>
    393. 

  393. <p><pre class="listing"><span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">onProgressChanged</span> <span class="Operator">=</span> <span class="Keyword">nil</span></pre></p>
    394. 

  394. <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    395. 

  395. The <tt class="docutils literal"><span class="pre"><span class="Identifier">total</span></span></tt> reported by httpclient may be 0 in some cases.</div>
    396. 

  396. 

  397. <h1><a class="toc-backref" id="sslslashtls-support" href="#sslslashtls-support">SSL/TLS support</a></h1><p>This requires the OpenSSL library. Fortunately it's widely used and installed on many operating systems. httpclient will use SSL automatically if you give any of the functions a url with the <tt class="docutils literal"><span class="pre"><span class="Identifier">https</span></span></tt> schema, for example: <tt class="docutils literal"><span class="pre"><span class="Identifier">https</span><span class="Punctuation">:</span><span class="Operator">//</span><span class="Identifier">github</span><span class="Operator">.</span><span class="Identifier">com</span><span class="Operator">/</span></span></tt>.</p>
    398. 

  398. <p>You will also have to compile with <tt class="docutils literal"><span class="pre"><span class="Identifier">ssl</span></span></tt> defined like so: <tt class="docutils literal"><span class="pre"><span class="Identifier">nim</span> <span class="Identifier">c</span> <span class="Operator">-</span><span class="Identifier">d</span><span class="Punctuation">:</span><span class="Identifier">ssl</span> <span class="Operator">...</span></span></tt>.</p>
    399. 

  399. <p>Certificate validation is performed by default.</p>
    400. 

  400. <p>A set of directories and files from the <a class="reference external" href="ssl_certs.html">ssl_certs</a> module are scanned to locate CA certificates.</p>
    401. 

  401. <p>Example of setting SSL verification parameters in a new client:</p>
    402. 

  402. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Punctuation">[</span><span class="Identifier">net</span><span class="Punctuation">,</span> <span class="Identifier">httpclient</span><span class="Punctuation">]</span>
    403. 

  403. <span class="Keyword">var</span> <span class="Identifier">client</span> <span class="Operator">=</span> <span class="Identifier">newHttpClient</span><span class="Punctuation">(</span><span class="Identifier">sslContext</span><span class="Operator">=</span><span class="Identifier">newContext</span><span class="Punctuation">(</span><span class="Identifier">verifyMode</span><span class="Operator">=</span><span class="Identifier">CVerifyPeer</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre></p>
    404. 

  404. <p>There are three options for verify mode:</p>
    405. 

  405. <ul class="simple"><li><tt class="docutils literal"><span class="pre">CVerifyNone</span></tt>: certificates are not verified;</li>
    406. 

  406. <li><tt class="docutils literal"><span class="pre">CVerifyPeer</span></tt>: certificates are verified;</li>
    407. 

  407. <li><tt class="docutils literal"><span class="pre">CVerifyPeerUseEnvVars</span></tt>: certificates are verified and the optional environment variables SSL_CERT_FILE and SSL_CERT_DIR are also used to locate certificates</li>
    408. 

  408. </ul>
    409. 

  409. <p>See <a class="reference external" href="net.html#newContext.string,string,string,string">newContext</a> to tweak or disable certificate validation.</p>
    410. 

  410. 

  411. <h1><a class="toc-backref" id="timeouts" href="#timeouts">Timeouts</a></h1><p>Currently only the synchronous functions support a timeout. The timeout is measured in milliseconds, once it is set any call on a socket which may block will be susceptible to this timeout.</p>
    412. 

  412. <p>It may be surprising but the function as a whole can take longer than the specified timeout, only individual internal calls on the socket are affected. In practice this means that as long as the server is sending data an exception will not be raised, if however data does not reach the client within the specified timeout a <tt class="docutils literal"><span class="pre"><span class="Identifier">TimeoutError</span></span></tt> exception will be raised.</p>
    413. 

  413. <p>Here is how to set a timeout when creating an <tt class="docutils literal"><span class="pre"><span class="Identifier">HttpClient</span></span></tt> instance:</p>
    414. 

  414. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">httpclient</span>
    415. 

  415. 

  416. <span class="Keyword">let</span> <span class="Identifier">client</span> <span class="Operator">=</span> <span class="Identifier">newHttpClient</span><span class="Punctuation">(</span><span class="Identifier">timeout</span> <span class="Operator">=</span> <span class="DecNumber">42</span><span class="Punctuation">)</span></pre></p>
    417. 

  417. 

  418. <h1><a class="toc-backref" id="proxy" href="#proxy">Proxy</a></h1><p>A proxy can be specified as a param to any of the procedures defined in this module. To do this, use the <tt class="docutils literal"><span class="pre"><span class="Identifier">newProxy</span></span></tt> constructor. Unfortunately, only basic authentication is supported at the moment.</p>
    419. 

  419. <p>Some examples on how to configure a Proxy for <tt class="docutils literal"><span class="pre"><span class="Identifier">HttpClient</span></span></tt>:</p>
    420. 

  420. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">httpclient</span>
    421. 

  421. 

  422. <span class="Keyword">let</span> <span class="Identifier">myProxy</span> <span class="Operator">=</span> <span class="Identifier">newProxy</span><span class="Punctuation">(</span><span class="StringLit">&quot;http://myproxy.network&quot;</span><span class="Punctuation">)</span>
    423. 

  423. <span class="Keyword">let</span> <span class="Identifier">client</span> <span class="Operator">=</span> <span class="Identifier">newHttpClient</span><span class="Punctuation">(</span><span class="Identifier">proxy</span> <span class="Operator">=</span> <span class="Identifier">myProxy</span><span class="Punctuation">)</span></pre></p>
    424. 

  424. <p>Use proxies with basic authentication:</p>
    425. 

  425. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">httpclient</span>
    426. 

  426. 

  427. <span class="Keyword">let</span> <span class="Identifier">myProxy</span> <span class="Operator">=</span> <span class="Identifier">newProxy</span><span class="Punctuation">(</span><span class="StringLit">&quot;http://myproxy.network&quot;</span><span class="Punctuation">,</span> <span class="Identifier">auth</span><span class="Operator">=</span><span class="StringLit">&quot;user:password&quot;</span><span class="Punctuation">)</span>
    428. 

  428. <span class="Keyword">let</span> <span class="Identifier">client</span> <span class="Operator">=</span> <span class="Identifier">newHttpClient</span><span class="Punctuation">(</span><span class="Identifier">proxy</span> <span class="Operator">=</span> <span class="Identifier">myProxy</span><span class="Punctuation">)</span></pre></p>
    429. 

  429. <p>Get Proxy URL from environment variables:</p>
    430. 

  430. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">httpclient</span>
    431. 

  431. 

  432. <span class="Keyword">var</span> <span class="Identifier">url</span> <span class="Operator">=</span> <span class="StringLit">&quot;&quot;</span>
    433. 

  433. <span class="Keyword">try</span><span class="Punctuation">:</span>
    434. 

  434.   <span class="Keyword">if</span> <span class="Identifier">existsEnv</span><span class="Punctuation">(</span><span class="StringLit">&quot;http_proxy&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    435. 

  435.     <span class="Identifier">url</span> <span class="Operator">=</span> <span class="Identifier">getEnv</span><span class="Punctuation">(</span><span class="StringLit">&quot;http_proxy&quot;</span><span class="Punctuation">)</span>
    436. 

  436.   <span class="Keyword">elif</span> <span class="Identifier">existsEnv</span><span class="Punctuation">(</span><span class="StringLit">&quot;https_proxy&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    437. 

  437.     <span class="Identifier">url</span> <span class="Operator">=</span> <span class="Identifier">getEnv</span><span class="Punctuation">(</span><span class="StringLit">&quot;https_proxy&quot;</span><span class="Punctuation">)</span>
    438. 

  438. <span class="Keyword">except</span> <span class="Identifier">ValueError</span><span class="Punctuation">:</span>
    439. 

  439.   <span class="Identifier">echo</span> <span class="StringLit">&quot;Unable to parse proxy from environment variables.&quot;</span>
    440. 

  440. 

  441. <span class="Keyword">let</span> <span class="Identifier">myProxy</span> <span class="Operator">=</span> <span class="Identifier">newProxy</span><span class="Punctuation">(</span><span class="Identifier">url</span> <span class="Operator">=</span> <span class="Identifier">url</span><span class="Punctuation">)</span>
    442. 

  442. <span class="Keyword">let</span> <span class="Identifier">client</span> <span class="Operator">=</span> <span class="Identifier">newHttpClient</span><span class="Punctuation">(</span><span class="Identifier">proxy</span> <span class="Operator">=</span> <span class="Identifier">myProxy</span><span class="Punctuation">)</span></pre></p>
    443. 

  443. 

  444. <h1><a class="toc-backref" id="redirects" href="#redirects">Redirects</a></h1><p>The maximum redirects can be set with the <tt class="docutils literal"><span class="pre"><span class="Identifier">maxRedirects</span></span></tt> of <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt> type, it specifies the maximum amount of redirects to follow, it defaults to <tt class="docutils literal"><span class="pre"><span class="DecNumber">5</span></span></tt>, you can set it to <tt class="docutils literal"><span class="pre"><span class="DecNumber">0</span></span></tt> to disable redirects.</p>
    445. 

  445. <p>Here you can see an example about how to set the <tt class="docutils literal"><span class="pre"><span class="Identifier">maxRedirects</span></span></tt> of <tt class="docutils literal"><span class="pre"><span class="Identifier">HttpClient</span></span></tt>:</p>
    446. 

  446. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">httpclient</span>
    447. 

  447. 

  448. <span class="Keyword">let</span> <span class="Identifier">client</span> <span class="Operator">=</span> <span class="Identifier">newHttpClient</span><span class="Punctuation">(</span><span class="Identifier">maxRedirects</span> <span class="Operator">=</span> <span class="DecNumber">0</span><span class="Punctuation">)</span></pre></p>
    449. 

  449. </p>
    450. 

  450.     <div class="section" id="6">
    451. 

  451.   <h1><a class="toc-backref" href="#6">Imports</a></h1>
    452. 

  452.   <dl class="item">
    453. 

  453.     <a class="reference external" href="since.html">since</a>, <a class="reference external" href="net.html">net</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="uri.html">uri</a>, <a class="reference external" href="parseutils.html">parseutils</a>, <a class="reference external" href="base64.html">base64</a>, <a class="reference external" href="os.html">os</a>, <a class="reference external" href="mimetypes.html">mimetypes</a>, <a class="reference external" href="math.html">math</a>, <a class="reference external" href="random.html">random</a>, <a class="reference external" href="httpcore.html">httpcore</a>, <a class="reference external" href="times.html">times</a>, <a class="reference external" href="tables.html">tables</a>, <a class="reference external" href="streams.html">streams</a>, <a class="reference external" href="monotimes.html">monotimes</a>, <a class="reference external" href="asyncnet.html">asyncnet</a>, <a class="reference external" href="asyncdispatch.html">asyncdispatch</a>, <a class="reference external" href="asyncfile.html">asyncfile</a>, <a class="reference external" href="nativesockets.html">nativesockets</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="syncio.html">syncio</a>
    454. 

  454.   </dl>
    455. 

  455. </div>
    456. 

  456. <div class="section" id="7">
    457. 

  457.   <h1><a class="toc-backref" href="#7">Types</a></h1>
    458. 

  458.   <dl class="item">
    459. 

  459.     <div id="AsyncHttpClient">
    460. 

  460.   <dt><pre><a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a> <span class="Other">=</span> <a href="httpclient.html#HttpClientBase"><span class="Identifier">HttpClientBase</span></a><span class="Other">[</span><a href="asyncnet.html#AsyncSocket"><span class="Identifier">AsyncSocket</span></a><span class="Other">]</span></pre></dt>
    461. 

  461.   <dd>
    462. 

  462.     
    463. 

  463.     
    464. 

  464.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L663" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    465. 

  465. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L663" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    466. 

  466. 

  467.   </dd>
    468. 

  468. </div>
    469. 

  469. <div id="AsyncResponse">
    470. 

  470.   <dt><pre><a href="httpclient.html#AsyncResponse"><span class="Identifier">AsyncResponse</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span>
    471. 

  471.   <span class="Identifier">version</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>
    472. 

  472.   <span class="Identifier">status</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>
    473. 

  473.   <span class="Identifier">headers</span><span class="Operator">*</span><span class="Other">:</span> <a href="httpcore.html#HttpHeaders"><span class="Identifier">HttpHeaders</span></a>
    474. 

  474.   <span class="Identifier">bodyStream</span><span class="Operator">*</span><span class="Other">:</span> <a href="asyncstreams.html#FutureStream"><span class="Identifier">FutureStream</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span></pre></dt>
    475. 

  475.   <dd>
    476. 

  476.     
    477. 

  477.     
    478. 

  478.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L282" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    479. 

  479. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L282" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    480. 

  480. 

  481.   </dd>
    482. 

  482. </div>
    483. 

  483. <div id="HttpClient">
    484. 

  484.   <dt><pre><a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a> <span class="Other">=</span> <a href="httpclient.html#HttpClientBase"><span class="Identifier">HttpClientBase</span></a><span class="Other">[</span><a href="net.html#Socket"><span class="Identifier">Socket</span></a><span class="Other">]</span></pre></dt>
    485. 

  485.   <dd>
    486. 

  486.     
    487. 

  487.     
    488. 

  488.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L620" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    489. 

  489. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L620" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    490. 

  490. 

  491.   </dd>
    492. 

  492. </div>
    493. 

  493. <div id="HttpClientBase">
    494. 

  494.   <dt><pre><a href="httpclient.html#HttpClientBase"><span class="Identifier">HttpClientBase</span></a><span class="Other">[</span><span class="Identifier">SocketType</span><span class="Other">]</span> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span>
    495. 

  495.   <span class="Comment">## Where we are currently connected.</span>
    496. 

  496.   <span class="Identifier">headers</span><span class="Operator">*</span><span class="Other">:</span> <a href="httpcore.html#HttpHeaders"><span class="Identifier">HttpHeaders</span></a>      <span class="Comment">## Headers to send in requests.</span>
    497. 

  497.   <span class="Comment">## Maximum redirects, set to `0` to disable.</span>
    498. 

  498.   <span class="Identifier">timeout</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a>              <span class="Comment">## Only used for blocking HttpClient for now.</span>
    499. 

  499.   <span class="Comment">## `nil` or the callback to call when request progress changes.</span>
    500. 

  500.   <span class="Keyword">when</span> <span class="Identifier">SocketType</span> <span class="Keyword">is</span> <span class="Identifier">Socket</span><span class="Other">:</span>
    501. 

  501.     <span class="Identifier">onProgressChanged</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">ProgressChangedProc</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span>
    502. 

  502.   <span class="Keyword">else</span><span class="Other">:</span>
    503. 

  503.     <span class="Identifier">onProgressChanged</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">ProgressChangedProc</span><span class="Other">[</span><span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">]</span>
    504. 

  504.   <span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Other">(</span><span class="Identifier">ssl</span><span class="Other">)</span><span class="Other">:</span>
    505. 

  505.   <span class="Keyword">when</span> <span class="Identifier">SocketType</span> <span class="Keyword">is</span> <span class="Identifier">AsyncSocket</span><span class="Other">:</span>
    506. 

  506.   <span class="Keyword">else</span><span class="Other">:</span>
    507. 

  507.   <span class="Comment">## When `false`, the body is never read in requestAux.</span></pre></dt>
    508. 

  508.   <dd>
    509. 

  509.     
    510. 

  510.     
    511. 

  511.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L592" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    512. 

  512. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L592" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    513. 

  513. 

  514.   </dd>
    515. 

  515. </div>
    516. 

  516. <div id="HttpRequestError">
    517. 

  517.   <dt><pre><a href="httpclient.html#HttpRequestError"><span class="Identifier">HttpRequestError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a></pre></dt>
    518. 

  518.   <dd>
    519. 

  519.     
    520. 

  520.     Thrown in the <tt class="docutils literal"><span class="pre"><span class="Identifier">getContent</span></span></tt> proc and <tt class="docutils literal"><span class="pre"><span class="Identifier">postContent</span></span></tt> proc, when the server returns an error
    521. 

  521.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L360" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    522. 

  522. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L360" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    523. 

  523. 

  524.   </dd>
    525. 

  525. </div>
    526. 

  526. <div id="MultipartData">
    527. 

  527.   <dt><pre><a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span></pre></dt>
    528. 

  528.   <dd>
    529. 

  529.     
    530. 

  530.     
    531. 

  531.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L353" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    532. 

  532. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L353" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    533. 

  533. 

  534.   </dd>
    535. 

  535. </div>
    536. 

  536. <div id="MultipartEntries">
    537. 

  537.   <dt><pre><a href="httpclient.html#MultipartEntries"><span class="Identifier">MultipartEntries</span></a> <span class="Other">=</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">name</span><span class="Other">,</span> <span class="Identifier">content</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">]</span></pre></dt>
    538. 

  538.   <dd>
    539. 

  539.     
    540. 

  540.     
    541. 

  541.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L352" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    542. 

  542. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L352" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    543. 

  543. 

  544.   </dd>
    545. 

  545. </div>
    546. 

  546. <div id="ProgressChangedProc">
    547. 

  547.   <dt><pre><a href="httpclient.html#ProgressChangedProc"><span class="Identifier">ProgressChangedProc</span></a><span class="Other">[</span><span class="Identifier">ReturnType</span><span class="Other">]</span> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">total</span><span class="Other">,</span> <span class="Identifier">progress</span><span class="Other">,</span> <span class="Identifier">speed</span><span class="Other">:</span> <a href="ctypes.html#BiggestInt"><span class="Identifier">BiggestInt</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ReturnType</span> {.
    548. 

  548.     <span class="Identifier">closure</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span></span>.}</pre></dt>
    549. 

  549.   <dd>
    550. 

  550.     
    551. 

  551.     
    552. 

  552.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L588" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    553. 

  553. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L588" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    554. 

  554. 

  555.   </dd>
    556. 

  556. </div>
    557. 

  557. <div id="ProtocolError">
    558. 

  558.   <dt><pre><a href="httpclient.html#ProtocolError"><span class="Identifier">ProtocolError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a></pre></dt>
    559. 

  559.   <dd>
    560. 

  560.     
    561. 

  561.     exception that is raised when server does not conform to the implemented protocol
    562. 

  562.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L356" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    563. 

  563. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L356" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    564. 

  564. 

  565.   </dd>
    566. 

  566. </div>
    567. 

  567. <div id="Proxy">
    568. 

  568.   <dt><pre><a href="httpclient.html#Proxy"><span class="Identifier">Proxy</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span>
    569. 

  569.   <span class="Identifier">url</span><span class="Operator">*</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a>
    570. 

  570.   <span class="Identifier">auth</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    571. 

  571.   <dd>
    572. 

  572.     
    573. 

  573.     
    574. 

  574.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L339" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    575. 

  575. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L339" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    576. 

  576. 

  577.   </dd>
    578. 

  578. </div>
    579. 

  579. <div id="Response">
    580. 

  580.   <dt><pre><a href="httpclient.html#Response"><span class="Identifier">Response</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span>
    581. 

  581.   <span class="Identifier">version</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>
    582. 

  582.   <span class="Identifier">status</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>
    583. 

  583.   <span class="Identifier">headers</span><span class="Operator">*</span><span class="Other">:</span> <a href="httpcore.html#HttpHeaders"><span class="Identifier">HttpHeaders</span></a>
    584. 

  584.   <span class="Identifier">bodyStream</span><span class="Operator">*</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a></pre></dt>
    585. 

  585.   <dd>
    586. 

  586.     
    587. 

  587.     
    588. 

  588.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L275" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    589. 

  589. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L275" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    590. 

  590. 

  591.   </dd>
    592. 

  592. </div>
    593. 

  593. 

  594.   </dl>
    595. 

  595. </div>
    596. 

  596. <div class="section" id="10">
    597. 

  597.   <h1><a class="toc-backref" href="#10">Consts</a></h1>
    598. 

  598.   <dl class="item">
    599. 

  599.     <div id="defUserAgent">
    600. 

  600.   <dt><pre><a href="httpclient.html#defUserAgent"><span class="Identifier">defUserAgent</span></a> <span class="Other">=</span> <span class="StringLit">&quot;Nim-httpclient/2.3.1&quot;</span></pre></dt>
    601. 

  601.   <dd>
    602. 

  602.     
    603. 

  603.     
    604. 

  604.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L364" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    605. 

  605. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L364" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    606. 

  606. 

  607.   </dd>
    608. 

  608. </div>
    609. 

  609. 

  610.   </dl>
    611. 

  611. </div>
    612. 

  612. <div class="section" id="12">
    613. 

  613.   <h1><a class="toc-backref" href="#12">Procs</a></h1>
    614. 

  614.   <dl class="item">
    615. 

  615.     <div id="$-procs-all">
    616. 

  616.   <div id="$,MultipartData">
    617. 

  617.   <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CMultipartData"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">data</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    618. 

  618.   <dd>
    619. 

  619.     
    620. 

  620.     convert MultipartData to string so it's human readable when echo see <a class="reference external" href="https://github.com/nim-lang/Nim/issues/11863">https://github.com/nim-lang/Nim/issues/11863</a>
    621. 

  621.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L402" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    622. 

  622. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L402" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    623. 

  623. 

  624.   </dd>
    625. 

  625. </div>
    626. 

  626. 

  627. </div>
    628. 

  628. <div id="[]=-procs-all">
    629. 

  629.   <div id="[]=,MultipartData,string,string">
    630. 

  630.   <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%3D%2CMultipartData%2Cstring%2Cstring"><span class="Identifier">`[]=`</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">,</span> <span class="Identifier">content</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
    631. 

  631.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    632. 

  632.   <dd>
    633. 

  633.     
    634. 

  634.     <p>Add a multipart entry to the multipart data <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt>. The value is added without a filename and without a content type.</p>
    635. 

  635. <p><pre class="listing"><span class="Identifier">data</span><span class="Punctuation">[</span><span class="StringLit">&quot;username&quot;</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="StringLit">&quot;NimUser&quot;</span></pre></p>
    636. 

  636. 

  637.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L488" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    638. 

  638. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L488" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    639. 

  639. 

  640.   </dd>
    641. 

  641. </div>
    642. 

  642. <div id="[]=,MultipartData,string,tuple[string,string,string]">
    643. 

  643.   <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%3D%2CMultipartData%2Cstring%2Ctuple%5Bstring%2Cstring%2Cstring%5D"><span class="Identifier">`[]=`</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
    644. 

  644.            <span class="Identifier">file</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">name</span><span class="Other">,</span> <span class="Identifier">contentType</span><span class="Other">,</span> <span class="Identifier">content</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
    645. 

  645.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    646. 

  646.   <dd>
    647. 

  647.     
    648. 

  648.     <p>Add a file to the multipart data <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt>, specifying filename, contentType and content manually.</p>
    649. 

  649. <p><pre class="listing"><span class="Identifier">data</span><span class="Punctuation">[</span><span class="StringLit">&quot;uploaded_file&quot;</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Punctuation">(</span><span class="StringLit">&quot;test.html&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;text/html&quot;</span><span class="Punctuation">,</span>
    650. 

  650.   <span class="StringLit">&quot;&lt;html&gt;&lt;head&gt;&lt;/head&gt;&lt;body&gt;&lt;p&gt;test&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;&quot;</span><span class="Punctuation">)</span></pre></p>
    651. 

  651. 

  652.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L497" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    653. 

  653. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L497" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    654. 

  654. 

  655.   </dd>
    656. 

  656. </div>
    657. 

  657. 

  658. </div>
    659. 

  659. <div id="add-procs-all">
    660. 

  660.   <div id="add,MultipartData,string,string,string,string">
    661. 

  661.   <dt><pre><span class="Keyword">proc</span> <a href="#add%2CMultipartData%2Cstring%2Cstring%2Cstring%2Cstring"><span class="Identifier">add</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">,</span> <span class="Identifier">content</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    662. 

  662.          <span class="Identifier">contentType</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">useStream</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
    663. 

  663.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    664. 

  664.   <dd>
    665. 

  665.     
    666. 

  666.     <p>Add a value to the multipart data.</p>
    667. 

  667. <p>When <tt class="docutils literal"><span class="pre"><span class="Identifier">useStream</span></span></tt> is <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt>, the file will be read into memory.</p>
    668. 

  668. <p>Raises a <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> exception if <tt class="docutils literal"><span class="pre"><span class="Identifier">name</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">contentType</span></span></tt> contain newline characters.</p>
    669. 

  669. 

  670.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L415" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    671. 

  671. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L415" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    672. 

  672. 

  673.   </dd>
    674. 

  674. </div>
    675. 

  675. <div id="add,MultipartData,MultipartEntries">
    676. 

  676.   <dt><pre><span class="Keyword">proc</span> <a href="#add%2CMultipartData%2CMultipartEntries"><span class="Identifier">add</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a><span class="Other">;</span> <span class="Identifier">xs</span><span class="Other">:</span> <a href="httpclient.html#MultipartEntries"><span class="Identifier">MultipartEntries</span></a><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> {.<span class="Identifier">discardable</span><span class="Other">,</span>
    677. 

  677.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    678. 

  678.   <dd>
    679. 

  679.     
    680. 

  680.     <p>Add a list of multipart entries to the multipart data <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt>. All values are added without a filename and without a content type.</p>
    681. 

  681. <p><pre class="listing"><span class="Identifier">data</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Punctuation">{</span><span class="StringLit">&quot;action&quot;</span><span class="Punctuation">:</span> <span class="StringLit">&quot;login&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;format&quot;</span><span class="Punctuation">:</span> <span class="StringLit">&quot;json&quot;</span><span class="Punctuation">}</span><span class="Punctuation">)</span></pre></p>
    682. 

  682. 

  683.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L443" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    684. 

  684. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L443" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    685. 

  685. 

  686.   </dd>
    687. 

  687. </div>
    688. 

  688. 

  689. </div>
    690. 

  690. <div id="addFiles-procs-all">
    691. 

  691.   <div id="addFiles,MultipartData,openArray[tuple[string,string]]">
    692. 

  692.   <dt><pre><span class="Keyword">proc</span> <a href="#addFiles%2CMultipartData%2CopenArray%5Btuple%5Bstring%2Cstring%5D%5D"><span class="Identifier">addFiles</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a><span class="Other">;</span> <span class="Identifier">xs</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">name</span><span class="Other">,</span> <span class="Identifier">file</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">]</span><span class="Other">;</span>
    693. 

  693.               <span class="Identifier">mimeDb</span> <span class="Other">=</span> <span class="Identifier">newMimetypes</span><span class="Other">(</span><span class="Other">)</span><span class="Other">;</span> <span class="Identifier">useStream</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> {.
    694. 

  694.     <span class="Identifier">discardable</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    695. 

  695.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    696. 

  696.   <dd>
    697. 

  697.     
    698. 

  698.     <p>Add files to a multipart data object. The files will be streamed from disk when the request is being made. When <tt class="docutils literal"><span class="pre"><span class="Identifier">stream</span></span></tt> is <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt>, the files are instead read into memory, but beware this is very memory ineffecient even for small files. The MIME types will automatically be determined. Raises an <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if the file cannot be opened or reading fails. To manually specify file content, filename and MIME type, use <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Punctuation">]</span><span class="Operator">=</span></span></tt> instead.</p>
    699. 

  699. <p><pre class="listing"><span class="Identifier">data</span><span class="Operator">.</span><span class="Identifier">addFiles</span><span class="Punctuation">(</span><span class="Punctuation">{</span><span class="StringLit">&quot;uploaded_file&quot;</span><span class="Punctuation">:</span> <span class="StringLit">&quot;public/test.html&quot;</span><span class="Punctuation">}</span><span class="Punctuation">)</span></pre></p>
    700. 

  700. 

  701.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L466" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    702. 

  702. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L466" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    703. 

  703. 

  704.   </dd>
    705. 

  705. </div>
    706. 

  706. 

  707. </div>
    708. 

  708. <div id="body-procs-all">
    709. 

  709.   <div id="body,AsyncResponse">
    710. 

  710.   <dt><pre><span class="Keyword">proc</span> <a href="#body%2CAsyncResponse"><span class="Identifier">body</span></a><span class="Other">(</span><span class="Identifier">response</span><span class="Other">:</span> <a href="httpclient.html#AsyncResponse"><span class="Identifier">AsyncResponse</span></a><span class="Other">)</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
    711. 

  711.     <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    712. 

  712.   <dd>
    713. 

  713.     
    714. 

  714.     Reads the response's body and caches it. The read is performed only once.
    715. 

  715.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L331" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    716. 

  716. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L331" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    717. 

  717. 

  718.   </dd>
    719. 

  719. </div>
    720. 

  720. <div id="body,Response">
    721. 

  721.   <dt><pre><span class="Keyword">proc</span> <a href="#body%2CResponse"><span class="Identifier">body</span></a><span class="Other">(</span><span class="Identifier">response</span><span class="Other">:</span> <a href="httpclient.html#Response"><span class="Identifier">Response</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    722. 

  722.                                         <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    723. 

  723.   <dd>
    724. 

  724.     
    725. 

  725.     <p>Retrieves the specified response's body.</p>
    726. 

  726. <p>The response's body stream is read synchronously.</p>
    727. 

  727. 

  728.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L323" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    729. 

  729. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L323" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    730. 

  730. 

  731.   </dd>
    732. 

  732. </div>
    733. 

  733. 

  734. </div>
    735. 

  735. <div id="close-procs-all">
    736. 

  736.   <div id="close">
    737. 

  737.   <dt><pre><span class="Keyword">proc</span> <a href="#close"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a> <span class="Operator">|</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">)</span></pre></dt>
    738. 

  738.   <dd>
    739. 

  739.     
    740. 

  740.     Closes any connections held by the HTTP client.
    741. 

  741.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L705" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    742. 

  742. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L705" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    743. 

  743. 

  744.   </dd>
    745. 

  745. </div>
    746. 

  746. 

  747. </div>
    748. 

  748. <div id="code-procs-all">
    749. 

  749.   <div id="code">
    750. 

  750.   <dt><pre><span class="Keyword">proc</span> <a href="#code"><span class="Identifier">code</span></a><span class="Other">(</span><span class="Identifier">response</span><span class="Other">:</span> <a href="httpclient.html#Response"><span class="Identifier">Response</span></a> <span class="Operator">|</span> <a href="httpclient.html#AsyncResponse"><span class="Identifier">AsyncResponse</span></a><span class="Other">)</span><span class="Other">:</span> <a href="httpcore.html#HttpCode"><span class="Identifier">HttpCode</span></a> {.
    751. 

  751.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a><span class="Other">,</span> <a href="exceptions.html#OverflowDefect"><span class="Identifier">OverflowDefect</span></a><span class="Other">]</span></span>.}</pre></dt>
    752. 

  752.   <dd>
    753. 

  753.     
    754. 

  754.     <p>Retrieves the specified response's <tt class="docutils literal"><span class="pre"><span class="Identifier">HttpCode</span></span></tt>.</p>
    755. 

  755. <p>Raises a <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> if the response's <tt class="docutils literal"><span class="pre"><span class="Identifier">status</span></span></tt> does not have a corresponding <tt class="docutils literal"><span class="pre"><span class="Identifier">HttpCode</span></span></tt>.</p>
    756. 

  756. 

  757.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L289" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    758. 

  758. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L289" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    759. 

  759. 

  760.   </dd>
    761. 

  761. </div>
    762. 

  762. 

  763. </div>
    764. 

  764. <div id="contentLength-procs-all">
    765. 

  765.   <div id="contentLength">
    766. 

  766.   <dt><pre><span class="Keyword">proc</span> <a href="#contentLength"><span class="Identifier">contentLength</span></a><span class="Other">(</span><span class="Identifier">response</span><span class="Other">:</span> <a href="httpclient.html#Response"><span class="Identifier">Response</span></a> <span class="Operator">|</span> <a href="httpclient.html#AsyncResponse"><span class="Identifier">AsyncResponse</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
    767. 

  767.   <dd>
    768. 

  768.     
    769. 

  769.     <p>Retrieves the specified response's content length.</p>
    770. 

  770. <p>This is effectively the value of the &quot;Content-Length&quot; header.</p>
    771. 

  771. <p>A <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> exception will be raised if the value is not an integer. If the Content-Length header is not set in the response, ContentLength is set to the value -1.</p>
    772. 

  772. 

  773.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L303" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    774. 

  774. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L303" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    775. 

  775. 

  776.   </dd>
    777. 

  777. </div>
    778. 

  778. 

  779. </div>
    780. 

  780. <div id="contentType-procs-all">
    781. 

  781.   <div id="contentType">
    782. 

  782.   <dt><pre><span class="Keyword">proc</span> <a href="#contentType"><span class="Identifier">contentType</span></a><span class="Other">(</span><span class="Identifier">response</span><span class="Other">:</span> <a href="httpclient.html#Response"><span class="Identifier">Response</span></a> <span class="Operator">|</span> <a href="httpclient.html#AsyncResponse"><span class="Identifier">AsyncResponse</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">inline</span>.}</pre></dt>
    783. 

  783.   <dd>
    784. 

  784.     
    785. 

  785.     <p>Retrieves the specified response's content type.</p>
    786. 

  786. <p>This is effectively the value of the &quot;Content-Type&quot; header.</p>
    787. 

  787. 

  788.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L297" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    789. 

  789. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L297" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    790. 

  790. 

  791.   </dd>
    792. 

  792. </div>
    793. 

  793. 

  794. </div>
    795. 

  795. <div id="delete-procs-all">
    796. 

  796.   <div id="delete,AsyncHttpClient,">
    797. 

  797.   <dt><pre><span class="Keyword">proc</span> <a href="#delete%2CAsyncHttpClient%2C"><span class="Identifier">delete</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="httpclient.html#AsyncResponse"><span class="Identifier">AsyncResponse</span></a><span class="Other">]</span> {.
    798. 

  798.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span></span>.}</pre></dt>
    799. 

  799.   <dd>
    800. 

  800.     
    801. 

  801.     Connects to the hostname specified by the URL and performs a DELETE request. This procedure uses httpClient values such as <tt class="docutils literal"><span class="pre"><span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">maxRedirects</span></span></tt>.
    802. 

  802.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1263" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    803. 

  803. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1263" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    804. 

  804. 

  805.   </dd>
    806. 

  806. </div>
    807. 

  807. <div id="delete,HttpClient,">
    808. 

  808.   <dt><pre><span class="Keyword">proc</span> <a href="#delete%2CHttpClient%2C"><span class="Identifier">delete</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#Response"><span class="Identifier">Response</span></a></pre></dt>
    809. 

  809.   <dd>
    810. 

  810.     
    811. 

  811.     
    812. 

  812.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1264" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    813. 

  813. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1264" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    814. 

  814. 

  815.   </dd>
    816. 

  816. </div>
    817. 

  817. 

  818. </div>
    819. 

  819. <div id="deleteContent-procs-all">
    820. 

  820.   <div id="deleteContent,AsyncHttpClient,">
    821. 

  821.   <dt><pre><span class="Keyword">proc</span> <a href="#deleteContent%2CAsyncHttpClient%2C"><span class="Identifier">deleteContent</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.
    822. 

  822.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span></span>.}</pre></dt>
    823. 

  823.   <dd>
    824. 

  824.     
    825. 

  825.     Connects to the hostname specified by the URL and returns the content of a DELETE request.
    826. 

  826.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1269" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    827. 

  827. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1269" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    828. 

  828. 

  829.   </dd>
    830. 

  830. </div>
    831. 

  831. <div id="deleteContent,HttpClient,">
    832. 

  832.   <dt><pre><span class="Keyword">proc</span> <a href="#deleteContent%2CHttpClient%2C"><span class="Identifier">deleteContent</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    833. 

  833.   <dd>
    834. 

  834.     
    835. 

  835.     
    836. 

  836.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1270" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    837. 

  837. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1270" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    838. 

  838. 

  839.   </dd>
    840. 

  840. </div>
    841. 

  841. 

  842. </div>
    843. 

  843. <div id="downloadFile-procs-all">
    844. 

  844.   <div id="downloadFile,AsyncHttpClient,,string">
    845. 

  845.   <dt><pre><span class="Keyword">proc</span> <a href="#downloadFile%2CAsyncHttpClient%2C%2Cstring"><span class="Identifier">downloadFile</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span>
    846. 

  846.     <a href="system.html#void"><span class="Identifier">void</span></a><span class="Other">]</span></pre></dt>
    847. 

  847.   <dd>
    848. 

  848.     
    849. 

  849.     
    850. 

  850.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1354" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    851. 

  851. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1354" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    852. 

  852. 

  853.   </dd>
    854. 

  854. </div>
    855. 

  855. <div id="downloadFile,HttpClient,,string">
    856. 

  856.   <dt><pre><span class="Keyword">proc</span> <a href="#downloadFile%2CHttpClient%2C%2Cstring"><span class="Identifier">downloadFile</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span></pre></dt>
    857. 

  857.   <dd>
    858. 

  858.     
    859. 

  859.     Downloads <tt class="docutils literal"><span class="pre"><span class="Identifier">url</span></span></tt> and saves it to <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt>.
    860. 

  860.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1316" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    861. 

  861. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1316" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    862. 

  862. 

  863.   </dd>
    864. 

  864. </div>
    865. 

  865. 

  866. </div>
    867. 

  867. <div id="get-procs-all">
    868. 

  868.   <div id="get,AsyncHttpClient,">
    869. 

  869.   <dt><pre><span class="Keyword">proc</span> <a href="#get%2CAsyncHttpClient%2C"><span class="Identifier">get</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="httpclient.html#AsyncResponse"><span class="Identifier">AsyncResponse</span></a><span class="Other">]</span> {.
    870. 

  870.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span></span>.}</pre></dt>
    871. 

  871.   <dd>
    872. 

  872.     
    873. 

  873.     <p>Connects to the hostname specified by the URL and performs a GET request.</p>
    874. 

  874. <p>This procedure uses httpClient values such as <tt class="docutils literal"><span class="pre"><span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">maxRedirects</span></span></tt>.</p>
    875. 

  875. 

  876.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1250" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    877. 

  877. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1250" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    878. 

  878. 

  879.   </dd>
    880. 

  880. </div>
    881. 

  881. <div id="get,HttpClient,">
    882. 

  882.   <dt><pre><span class="Keyword">proc</span> <a href="#get%2CHttpClient%2C"><span class="Identifier">get</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#Response"><span class="Identifier">Response</span></a></pre></dt>
    883. 

  883.   <dd>
    884. 

  884.     
    885. 

  885.     
    886. 

  886.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1251" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    887. 

  887. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1251" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    888. 

  888. 

  889.   </dd>
    890. 

  890. </div>
    891. 

  891. 

  892. </div>
    893. 

  893. <div id="getContent-procs-all">
    894. 

  894.   <div id="getContent,AsyncHttpClient,">
    895. 

  895.   <dt><pre><span class="Keyword">proc</span> <a href="#getContent%2CAsyncHttpClient%2C"><span class="Identifier">getContent</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.
    896. 

  896.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span></span>.}</pre></dt>
    897. 

  897.   <dd>
    898. 

  898.     
    899. 

  899.     Connects to the hostname specified by the URL and returns the content of a GET request.
    900. 

  900.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1257" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    901. 

  901. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1257" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    902. 

  902. 

  903.   </dd>
    904. 

  904. </div>
    905. 

  905. <div id="getContent,HttpClient,">
    906. 

  906.   <dt><pre><span class="Keyword">proc</span> <a href="#getContent%2CHttpClient%2C"><span class="Identifier">getContent</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    907. 

  907.   <dd>
    908. 

  908.     
    909. 

  909.     
    910. 

  910.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1258" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    911. 

  911. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1258" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    912. 

  912. 

  913.   </dd>
    914. 

  914. </div>
    915. 

  915. 

  916. </div>
    917. 

  917. <div id="getSocket-procs-all">
    918. 

  918.   <div id="getSocket,AsyncHttpClient">
    919. 

  919.   <dt><pre><span class="Keyword">proc</span> <a href="#getSocket%2CAsyncHttpClient"><span class="Identifier">getSocket</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">)</span><span class="Other">:</span> <a href="asyncnet.html#AsyncSocket"><span class="Identifier">AsyncSocket</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    920. 

  920.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    921. 

  921.   <dd>
    922. 

  922.     
    923. 

  923.     
    924. 

  924.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L723" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    925. 

  925. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L723" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    926. 

  926. 

  927.   </dd>
    928. 

  928. </div>
    929. 

  929. <div id="getSocket,HttpClient">
    930. 

  930.   <dt><pre><span class="Keyword">proc</span> <a href="#getSocket%2CHttpClient"><span class="Identifier">getSocket</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a><span class="Other">)</span><span class="Other">:</span> <a href="net.html#Socket"><span class="Identifier">Socket</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    931. 

  931.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    932. 

  932.   <dd>
    933. 

  933.     
    934. 

  934.     <p>Get network socket, useful if you want to find out more details about the connection.</p>
    935. 

  935. <p>This example shows info about local and remote endpoints:</p>
    936. 

  936. <p><pre class="listing"><span class="Keyword">if</span> <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">connected</span><span class="Punctuation">:</span>
    937. 

  937.   <span class="Identifier">echo</span> <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">getSocket</span><span class="Operator">.</span><span class="Identifier">getLocalAddr</span>
    938. 

  938.   <span class="Identifier">echo</span> <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">getSocket</span><span class="Operator">.</span><span class="Identifier">getPeerAddr</span></pre></p>
    939. 

  939. 

  940.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L711" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    941. 

  941. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L711" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    942. 

  942. 

  943.   </dd>
    944. 

  944. </div>
    945. 

  945. 

  946. </div>
    947. 

  947. <div id="head-procs-all">
    948. 

  948.   <div id="head,AsyncHttpClient,">
    949. 

  949.   <dt><pre><span class="Keyword">proc</span> <a href="#head%2CAsyncHttpClient%2C"><span class="Identifier">head</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="httpclient.html#AsyncResponse"><span class="Identifier">AsyncResponse</span></a><span class="Other">]</span> {.
    950. 

  950.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span></span>.}</pre></dt>
    951. 

  951.   <dd>
    952. 

  952.     
    953. 

  953.     <p>Connects to the hostname specified by the URL and performs a HEAD request.</p>
    954. 

  954. <p>This procedure uses httpClient values such as <tt class="docutils literal"><span class="pre"><span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">maxRedirects</span></span></tt>.</p>
    955. 

  955. 

  956.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1243" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    957. 

  957. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1243" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    958. 

  958. 

  959.   </dd>
    960. 

  960. </div>
    961. 

  961. <div id="head,HttpClient,">
    962. 

  962.   <dt><pre><span class="Keyword">proc</span> <a href="#head%2CHttpClient%2C"><span class="Identifier">head</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#Response"><span class="Identifier">Response</span></a></pre></dt>
    963. 

  963.   <dd>
    964. 

  964.     
    965. 

  965.     
    966. 

  966.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1244" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    967. 

  967. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1244" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    968. 

  968. 

  969.   </dd>
    970. 

  970. </div>
    971. 

  971. 

  972. </div>
    973. 

  973. <div id="lastModified-procs-all">
    974. 

  974.   <div id="lastModified">
    975. 

  975.   <dt><pre><span class="Keyword">proc</span> <a href="#lastModified"><span class="Identifier">lastModified</span></a><span class="Other">(</span><span class="Identifier">response</span><span class="Other">:</span> <a href="httpclient.html#Response"><span class="Identifier">Response</span></a> <span class="Operator">|</span> <a href="httpclient.html#AsyncResponse"><span class="Identifier">AsyncResponse</span></a><span class="Other">)</span><span class="Other">:</span> <a href="times.html#DateTime"><span class="Identifier">DateTime</span></a></pre></dt>
    976. 

  976.   <dd>
    977. 

  977.     
    978. 

  978.     <p>Retrieves the specified response's last modified time.</p>
    979. 

  979. <p>This is effectively the value of the &quot;Last-Modified&quot; header.</p>
    980. 

  980. <p>Raises a <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> if the parsing fails or the value is not a correctly formatted time.</p>
    981. 

  981. 

  982.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L313" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    983. 

  983. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L313" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    984. 

  984. 

  985.   </dd>
    986. 

  986. </div>
    987. 

  987. 

  988. </div>
    989. 

  989. <div id="newAsyncHttpClient-procs-all">
    990. 

  990.   <div id="newAsyncHttpClient,int,Proxy">
    991. 

  991.   <dt><pre><span class="Keyword">proc</span> <a href="#newAsyncHttpClient%2Cint%2CProxy"><span class="Identifier">newAsyncHttpClient</span></a><span class="Other">(</span><span class="Identifier">userAgent</span> <span class="Other">=</span> <span class="Identifier">defUserAgent</span><span class="Other">;</span> <span class="Identifier">maxRedirects</span> <span class="Other">=</span> <span class="DecNumber">5</span><span class="Other">;</span>
    992. 

  992.                         <span class="Identifier">sslContext</span> <span class="Other">=</span> <span class="Identifier">getDefaultSSL</span><span class="Other">(</span><span class="Other">)</span><span class="Other">;</span> <span class="Identifier">proxy</span><span class="Other">:</span> <a href="httpclient.html#Proxy"><span class="Identifier">Proxy</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">;</span>
    993. 

  993.                         <span class="Identifier">headers</span> <span class="Other">=</span> <span class="Identifier">newHttpHeaders</span><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a> {.
    994. 

  994.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    995. 

  995.   <dd>
    996. 

  996.     
    997. 

  997.     <p>Creates a new AsyncHttpClient instance.</p>
    998. 

  998. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">userAgent</span></span></tt> specifies the user agent that will be used when making requests.</p>
    999. 

  999. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">maxRedirects</span></span></tt> specifies the maximum amount of redirects to follow, default is 5.</p>
    1000. 

  1000. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">sslContext</span></span></tt> specifies the SSL context to use for HTTPS requests.</p>
    1001. 

  1001. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">proxy</span></span></tt> specifies an HTTP proxy to use for this HTTP client's connections.</p>
    1002. 

  1002. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">headers</span></span></tt> specifies the HTTP Headers.</p>
    1003. 

  1003. 

  1004. <p><strong class="examples_text">Example:</strong></p>
    1005. 

  1005. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Punctuation">[</span><span class="Identifier">asyncdispatch</span><span class="Punctuation">,</span> <span class="Identifier">strutils</span><span class="Punctuation">]</span>
    1006. 

  1006. 

  1007. <span class="Keyword">proc</span> <span class="Identifier">asyncProc</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">Future</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">async</span><span class="Operator">.</span><span class="Punctuation">}</span> <span class="Operator">=</span>
    1008. 

  1008.   <span class="Keyword">let</span> <span class="Identifier">client</span> <span class="Operator">=</span> <span class="Identifier">newAsyncHttpClient</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1009. 

  1009.   <span class="Identifier">result</span> <span class="Operator">=</span> <span class="Identifier">await</span> <span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">getContent</span><span class="Punctuation">(</span><span class="StringLit">&quot;http://example.com&quot;</span><span class="Punctuation">)</span>
    1010. 

  1010. 

  1011. <span class="Keyword">let</span> <span class="Identifier">exampleHtml</span> <span class="Operator">=</span> <span class="Identifier">waitFor</span> <span class="Identifier">asyncProc</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1012. 

  1012. <span class="Identifier">assert</span> <span class="StringLit">&quot;Example Domain&quot;</span> <span class="Keyword">in</span> <span class="Identifier">exampleHtml</span>
    1013. 

  1013. <span class="Identifier">assert</span> <span class="StringLit">&quot;Pizza&quot;</span> <span class="Keyword">notin</span> <span class="Identifier">exampleHtml</span></pre>
    1014. 

  1014.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L665" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1015. 

  1015. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L665" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1016. 

  1016. 

  1017.   </dd>
    1018. 

  1018. </div>
    1019. 

  1019. 

  1020. </div>
    1021. 

  1021. <div id="newHttpClient-procs-all">
    1022. 

  1022.   <div id="newHttpClient,int,Proxy,int">
    1023. 

  1023.   <dt><pre><span class="Keyword">proc</span> <a href="#newHttpClient%2Cint%2CProxy%2Cint"><span class="Identifier">newHttpClient</span></a><span class="Other">(</span><span class="Identifier">userAgent</span> <span class="Other">=</span> <span class="Identifier">defUserAgent</span><span class="Other">;</span> <span class="Identifier">maxRedirects</span> <span class="Other">=</span> <span class="DecNumber">5</span><span class="Other">;</span>
    1024. 

  1024.                    <span class="Identifier">sslContext</span> <span class="Other">=</span> <span class="Identifier">getDefaultSSL</span><span class="Other">(</span><span class="Other">)</span><span class="Other">;</span> <span class="Identifier">proxy</span><span class="Other">:</span> <a href="httpclient.html#Proxy"><span class="Identifier">Proxy</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">;</span>
    1025. 

  1025.                    <span class="Identifier">timeout</span> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">;</span> <span class="Identifier">headers</span> <span class="Other">=</span> <span class="Identifier">newHttpHeaders</span><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a> {.
    1026. 

  1026.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1027. 

  1027.   <dd>
    1028. 

  1028.     
    1029. 

  1029.     <p>Creates a new HttpClient instance.</p>
    1030. 

  1030. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">userAgent</span></span></tt> specifies the user agent that will be used when making requests.</p>
    1031. 

  1031. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">maxRedirects</span></span></tt> specifies the maximum amount of redirects to follow, default is 5.</p>
    1032. 

  1032. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">sslContext</span></span></tt> specifies the SSL context to use for HTTPS requests. See <a class="reference external" href="#sslslashtls-support">SSL/TLS support</a></p>
    1033. 

  1033. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">proxy</span></span></tt> specifies an HTTP proxy to use for this HTTP client's connections.</p>
    1034. 

  1034. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">timeout</span></span></tt> specifies the number of milliseconds to allow before a <tt class="docutils literal"><span class="pre"><span class="Identifier">TimeoutError</span></span></tt> is raised.</p>
    1035. 

  1035. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">headers</span></span></tt> specifies the HTTP Headers.</p>
    1036. 

  1036. 

  1037. <p><strong class="examples_text">Example:</strong></p>
    1038. 

  1038. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">strutils</span>
    1039. 

  1039. 

  1040. <span class="Keyword">let</span> <span class="Identifier">exampleHtml</span> <span class="Operator">=</span> <span class="Identifier">newHttpClient</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">getContent</span><span class="Punctuation">(</span><span class="StringLit">&quot;http://example.com&quot;</span><span class="Punctuation">)</span>
    1041. 

  1041. <span class="Identifier">assert</span> <span class="StringLit">&quot;Example Domain&quot;</span> <span class="Keyword">in</span> <span class="Identifier">exampleHtml</span>
    1042. 

  1042. <span class="Identifier">assert</span> <span class="StringLit">&quot;Pizza&quot;</span> <span class="Keyword">notin</span> <span class="Identifier">exampleHtml</span></pre>
    1043. 

  1043.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L622" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1044. 

  1044. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L622" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1045. 

  1045. 

  1046.   </dd>
    1047. 

  1047. </div>
    1048. 

  1048. 

  1049. </div>
    1050. 

  1050. <div id="newMultipartData-procs-all">
    1051. 

  1051.   <div id="newMultipartData">
    1052. 

  1052.   <dt><pre><span class="Keyword">proc</span> <a href="#newMultipartData"><span class="Identifier">newMultipartData</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1053. 

  1053.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1054. 

  1054.   <dd>
    1055. 

  1055.     
    1056. 

  1056.     Constructs a new <tt class="docutils literal"><span class="pre"><span class="Identifier">MultipartData</span></span></tt> object.
    1057. 

  1057.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L398" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1058. 

  1058. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L398" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1059. 

  1059. 

  1060.   </dd>
    1061. 

  1061. </div>
    1062. 

  1062. <div id="newMultipartData,MultipartEntries">
    1063. 

  1063.   <dt><pre><span class="Keyword">proc</span> <a href="#newMultipartData%2CMultipartEntries"><span class="Identifier">newMultipartData</span></a><span class="Other">(</span><span class="Identifier">xs</span><span class="Other">:</span> <a href="httpclient.html#MultipartEntries"><span class="Identifier">MultipartEntries</span></a><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> {.
    1064. 

  1064.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1065. 

  1065.   <dd>
    1066. 

  1066.     
    1067. 

  1067.     <p>Create a new multipart data object and fill it with the entries <tt class="docutils literal"><span class="pre"><span class="Identifier">xs</span></span></tt> directly.</p>
    1068. 

  1068. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">data</span> <span class="Operator">=</span> <span class="Identifier">newMultipartData</span><span class="Punctuation">(</span><span class="Punctuation">{</span><span class="StringLit">&quot;action&quot;</span><span class="Punctuation">:</span> <span class="StringLit">&quot;login&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;format&quot;</span><span class="Punctuation">:</span> <span class="StringLit">&quot;json&quot;</span><span class="Punctuation">}</span><span class="Punctuation">)</span></pre></p>
    1069. 

  1069. 

  1070.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L455" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1071. 

  1071. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L455" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1072. 

  1072. 

  1073.   </dd>
    1074. 

  1074. </div>
    1075. 

  1075. 

  1076. </div>
    1077. 

  1077. <div id="newProxy-procs-all">
    1078. 

  1078.   <div id="newProxy,string,string">
    1079. 

  1079.   <dt><pre><span class="Keyword">proc</span> <a href="#newProxy%2Cstring%2Cstring"><span class="Identifier">newProxy</span></a><span class="Other">(</span><span class="Identifier">url</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">auth</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#Proxy"><span class="Identifier">Proxy</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1080. 

  1080.   <dd>
    1081. 

  1081.     
    1082. 

  1082.     Constructs a new <tt class="docutils literal"><span class="pre"><span class="Identifier">TProxy</span></span></tt> object.
    1083. 

  1083.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L390" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1084. 

  1084. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L390" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1085. 

  1085. 

  1086.   </dd>
    1087. 

  1087. </div>
    1088. 

  1088. <div id="newProxy,Uri,string">
    1089. 

  1089.   <dt><pre><span class="Keyword">proc</span> <a href="#newProxy%2CUri%2Cstring"><span class="Identifier">newProxy</span></a><span class="Other">(</span><span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a><span class="Other">;</span> <span class="Identifier">auth</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#Proxy"><span class="Identifier">Proxy</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1090. 

  1090.   <dd>
    1091. 

  1091.     
    1092. 

  1092.     Constructs a new <tt class="docutils literal"><span class="pre"><span class="Identifier">TProxy</span></span></tt> object.
    1093. 

  1093.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L394" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1094. 

  1094. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L394" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1095. 

  1095. 

  1096.   </dd>
    1097. 

  1097. </div>
    1098. 

  1098. 

  1099. </div>
    1100. 

  1100. <div id="patch-procs-all">
    1101. 

  1101.   <div id="patch,AsyncHttpClient,,string,MultipartData">
    1102. 

  1102.   <dt><pre><span class="Keyword">proc</span> <a href="#patch%2CAsyncHttpClient%2C%2Cstring%2CMultipartData"><span class="Identifier">patch</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">body</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    1103. 

  1103.            <span class="Identifier">multipart</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="httpclient.html#AsyncResponse"><span class="Identifier">AsyncResponse</span></a><span class="Other">]</span> {.
    1104. 

  1104.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span></span>.}</pre></dt>
    1105. 

  1105.   <dd>
    1106. 

  1106.     
    1107. 

  1107.     Connects to the hostname specified by the URL and performs a PATCH request. This procedure uses httpClient values such as <tt class="docutils literal"><span class="pre"><span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">maxRedirects</span></span></tt>.
    1108. 

  1108.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1302" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1109. 

  1109. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1302" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1110. 

  1110. 

  1111.   </dd>
    1112. 

  1112. </div>
    1113. 

  1113. <div id="patch,HttpClient,,string,MultipartData">
    1114. 

  1114.   <dt><pre><span class="Keyword">proc</span> <a href="#patch%2CHttpClient%2C%2Cstring%2CMultipartData"><span class="Identifier">patch</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">body</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    1115. 

  1115.            <span class="Identifier">multipart</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#Response"><span class="Identifier">Response</span></a></pre></dt>
    1116. 

  1116.   <dd>
    1117. 

  1117.     
    1118. 

  1118.     
    1119. 

  1119.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1304" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1120. 

  1120. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1304" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1121. 

  1121. 

  1122.   </dd>
    1123. 

  1123. </div>
    1124. 

  1124. 

  1125. </div>
    1126. 

  1126. <div id="patchContent-procs-all">
    1127. 

  1127.   <div id="patchContent,AsyncHttpClient,,string,MultipartData">
    1128. 

  1128.   <dt><pre><span class="Keyword">proc</span> <a href="#patchContent%2CAsyncHttpClient%2C%2Cstring%2CMultipartData"><span class="Identifier">patchContent</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">body</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    1129. 

  1129.                   <span class="Identifier">multipart</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.
    1130. 

  1130.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span></span>.}</pre></dt>
    1131. 

  1131.   <dd>
    1132. 

  1132.     
    1133. 

  1133.     Connects to the hostname specified by the URL and returns the content of a PATCH request.
    1134. 

  1134.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1309" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1135. 

  1135. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1309" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1136. 

  1136. 

  1137.   </dd>
    1138. 

  1138. </div>
    1139. 

  1139. <div id="patchContent,HttpClient,,string,MultipartData">
    1140. 

  1140.   <dt><pre><span class="Keyword">proc</span> <a href="#patchContent%2CHttpClient%2C%2Cstring%2CMultipartData"><span class="Identifier">patchContent</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">body</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    1141. 

  1141.                   <span class="Identifier">multipart</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    1142. 

  1142.   <dd>
    1143. 

  1143.     
    1144. 

  1144.     
    1145. 

  1145.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1311" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1146. 

  1146. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1311" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1147. 

  1147. 

  1148.   </dd>
    1149. 

  1149. </div>
    1150. 

  1150. 

  1151. </div>
    1152. 

  1152. <div id="post-procs-all">
    1153. 

  1153.   <div id="post,AsyncHttpClient,,string,MultipartData">
    1154. 

  1154.   <dt><pre><span class="Keyword">proc</span> <a href="#post%2CAsyncHttpClient%2C%2Cstring%2CMultipartData"><span class="Identifier">post</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">body</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    1155. 

  1155.           <span class="Identifier">multipart</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="httpclient.html#AsyncResponse"><span class="Identifier">AsyncResponse</span></a><span class="Other">]</span> {.
    1156. 

  1156.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span></span>.}</pre></dt>
    1157. 

  1157.   <dd>
    1158. 

  1158.     
    1159. 

  1159.     Connects to the hostname specified by the URL and performs a POST request. This procedure uses httpClient values such as <tt class="docutils literal"><span class="pre"><span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">maxRedirects</span></span></tt>.
    1160. 

  1160.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1275" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1161. 

  1161. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1275" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1162. 

  1162. 

  1163.   </dd>
    1164. 

  1164. </div>
    1165. 

  1165. <div id="post,HttpClient,,string,MultipartData">
    1166. 

  1166.   <dt><pre><span class="Keyword">proc</span> <a href="#post%2CHttpClient%2C%2Cstring%2CMultipartData"><span class="Identifier">post</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">body</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    1167. 

  1167.           <span class="Identifier">multipart</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#Response"><span class="Identifier">Response</span></a></pre></dt>
    1168. 

  1168.   <dd>
    1169. 

  1169.     
    1170. 

  1170.     
    1171. 

  1171.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1277" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1172. 

  1172. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1277" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1173. 

  1173. 

  1174.   </dd>
    1175. 

  1175. </div>
    1176. 

  1176. 

  1177. </div>
    1178. 

  1178. <div id="postContent-procs-all">
    1179. 

  1179.   <div id="postContent,AsyncHttpClient,,string,MultipartData">
    1180. 

  1180.   <dt><pre><span class="Keyword">proc</span> <a href="#postContent%2CAsyncHttpClient%2C%2Cstring%2CMultipartData"><span class="Identifier">postContent</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">body</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    1181. 

  1181.                  <span class="Identifier">multipart</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.
    1182. 

  1182.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span></span>.}</pre></dt>
    1183. 

  1183.   <dd>
    1184. 

  1184.     
    1185. 

  1185.     Connects to the hostname specified by the URL and returns the content of a POST request.
    1186. 

  1186.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1282" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1187. 

  1187. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1282" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1188. 

  1188. 

  1189.   </dd>
    1190. 

  1190. </div>
    1191. 

  1191. <div id="postContent,HttpClient,,string,MultipartData">
    1192. 

  1192.   <dt><pre><span class="Keyword">proc</span> <a href="#postContent%2CHttpClient%2C%2Cstring%2CMultipartData"><span class="Identifier">postContent</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">body</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    1193. 

  1193.                  <span class="Identifier">multipart</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    1194. 

  1194.   <dd>
    1195. 

  1195.     
    1196. 

  1196.     
    1197. 

  1197.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1284" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1198. 

  1198. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1284" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1199. 

  1199. 

  1200.   </dd>
    1201. 

  1201. </div>
    1202. 

  1202. 

  1203. </div>
    1204. 

  1204. <div id="put-procs-all">
    1205. 

  1205.   <div id="put,AsyncHttpClient,,string,MultipartData">
    1206. 

  1206.   <dt><pre><span class="Keyword">proc</span> <a href="#put%2CAsyncHttpClient%2C%2Cstring%2CMultipartData"><span class="Identifier">put</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">body</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    1207. 

  1207.          <span class="Identifier">multipart</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="httpclient.html#AsyncResponse"><span class="Identifier">AsyncResponse</span></a><span class="Other">]</span> {.
    1208. 

  1208.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span></span>.}</pre></dt>
    1209. 

  1209.   <dd>
    1210. 

  1210.     
    1211. 

  1211.     Connects to the hostname specified by the URL and performs a PUT request. This procedure uses httpClient values such as <tt class="docutils literal"><span class="pre"><span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">maxRedirects</span></span></tt>.
    1212. 

  1212.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1289" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1213. 

  1213. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1289" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1214. 

  1214. 

  1215.   </dd>
    1216. 

  1216. </div>
    1217. 

  1217. <div id="put,HttpClient,,string,MultipartData">
    1218. 

  1218.   <dt><pre><span class="Keyword">proc</span> <a href="#put%2CHttpClient%2C%2Cstring%2CMultipartData"><span class="Identifier">put</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">body</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    1219. 

  1219.          <span class="Identifier">multipart</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#Response"><span class="Identifier">Response</span></a></pre></dt>
    1220. 

  1220.   <dd>
    1221. 

  1221.     
    1222. 

  1222.     
    1223. 

  1223.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1291" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1224. 

  1224. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1291" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1225. 

  1225. 

  1226.   </dd>
    1227. 

  1227. </div>
    1228. 

  1228. 

  1229. </div>
    1230. 

  1230. <div id="putContent-procs-all">
    1231. 

  1231.   <div id="putContent,AsyncHttpClient,,string,MultipartData">
    1232. 

  1232.   <dt><pre><span class="Keyword">proc</span> <a href="#putContent%2CAsyncHttpClient%2C%2Cstring%2CMultipartData"><span class="Identifier">putContent</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">body</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    1233. 

  1233.                 <span class="Identifier">multipart</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.
    1234. 

  1234.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span></span>.}</pre></dt>
    1235. 

  1235.   <dd>
    1236. 

  1236.     
    1237. 

  1237.     Connects to the hostname specified by the URL andreturns the content of a PUT request.
    1238. 

  1238.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1296" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1239. 

  1239. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1296" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1240. 

  1240. 

  1241.   </dd>
    1242. 

  1242. </div>
    1243. 

  1243. <div id="putContent,HttpClient,,string,MultipartData">
    1244. 

  1244.   <dt><pre><span class="Keyword">proc</span> <a href="#putContent%2CHttpClient%2C%2Cstring%2CMultipartData"><span class="Identifier">putContent</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">body</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    1245. 

  1245.                 <span class="Identifier">multipart</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    1246. 

  1246.   <dd>
    1247. 

  1247.     
    1248. 

  1248.     
    1249. 

  1249.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1297" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1250. 

  1250. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1297" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1251. 

  1251. 

  1252.   </dd>
    1253. 

  1253. </div>
    1254. 

  1254. 

  1255. </div>
    1256. 

  1256. <div id="request-procs-all">
    1257. 

  1257.   <div id="request,AsyncHttpClient,,string,HttpHeaders,MultipartData">
    1258. 

  1258.   <dt><pre><span class="Keyword">proc</span> <a href="#request%2CAsyncHttpClient%2C%2Cstring%2CHttpHeaders%2CMultipartData"><span class="Identifier">request</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#AsyncHttpClient"><span class="Identifier">AsyncHttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
    1259. 

  1259.              <span class="Identifier">httpMethod</span><span class="Other">:</span> <a href="httpcore.html#HttpMethod"><span class="Identifier">HttpMethod</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="Identifier">HttpGet</span><span class="Other">;</span> <span class="Identifier">body</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    1260. 

  1260.              <span class="Identifier">headers</span><span class="Other">:</span> <a href="httpcore.html#HttpHeaders"><span class="Identifier">HttpHeaders</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">;</span> <span class="Identifier">multipart</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="asyncfutures.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span>
    1261. 

  1261.     <a href="httpclient.html#AsyncResponse"><span class="Identifier">AsyncResponse</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span></span>.}</pre></dt>
    1262. 

  1262.   <dd>
    1263. 

  1263.     
    1264. 

  1264.     <p>Connects to the hostname specified by the URL and performs a request using the custom method string specified by <tt class="docutils literal"><span class="pre"><span class="Identifier">httpMethod</span></span></tt>.</p>
    1265. 

  1265. <p>Connection will be kept alive. Further requests on the same <tt class="docutils literal"><span class="pre"><span class="Identifier">client</span></span></tt> to the same hostname will not require a new connection to be made. The connection can be closed by using the <tt class="docutils literal"><span class="pre"><span class="Identifier">close</span></span></tt> procedure.</p>
    1266. 

  1266. <p>This procedure will follow redirects up to a maximum number of redirects specified in <tt class="docutils literal"><span class="pre"><span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">maxRedirects</span></span></tt>.</p>
    1267. 

  1267. <p>You need to make sure that the <tt class="docutils literal"><span class="pre"><span class="Identifier">url</span></span></tt> doesn't contain any newline characters. Failing to do so will raise <tt class="docutils literal"><span class="pre"><span class="Identifier">AssertionDefect</span></span></tt>.</p>
    1268. 

  1268. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">headers</span></span></tt> are HTTP headers that override the <tt class="docutils literal"><span class="pre"><span class="Identifier">client</span><span class="Operator">.</span><span class="Identifier">headers</span></span></tt> for this specific request only and will not be persisted.</p>
    1269. 

  1269. <p><strong>Deprecated since v1.5</strong>: use HttpMethod enum instead; string parameter httpMethod is deprecated</p>
    1270. 

  1270. 

  1271.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1131" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1272. 

  1272. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1131" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1273. 

  1273. 

  1274.   </dd>
    1275. 

  1275. </div>
    1276. 

  1276. <div id="request,HttpClient,,string,HttpHeaders,MultipartData">
    1277. 

  1277.   <dt><pre><span class="Keyword">proc</span> <a href="#request%2CHttpClient%2C%2Cstring%2CHttpHeaders%2CMultipartData"><span class="Identifier">request</span></a><span class="Other">(</span><span class="Identifier">client</span><span class="Other">:</span> <a href="httpclient.html#HttpClient"><span class="Identifier">HttpClient</span></a><span class="Other">;</span> <span class="Identifier">url</span><span class="Other">:</span> <a href="uri.html#Uri"><span class="Identifier">Uri</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
    1278. 

  1278.              <span class="Identifier">httpMethod</span><span class="Other">:</span> <a href="httpcore.html#HttpMethod"><span class="Identifier">HttpMethod</span></a> <span class="Operator">|</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="Identifier">HttpGet</span><span class="Other">;</span> <span class="Identifier">body</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span>
    1279. 

  1279.              <span class="Identifier">headers</span><span class="Other">:</span> <a href="httpcore.html#HttpHeaders"><span class="Identifier">HttpHeaders</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">;</span> <span class="Identifier">multipart</span><span class="Other">:</span> <a href="httpclient.html#MultipartData"><span class="Identifier">MultipartData</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="httpclient.html#Response"><span class="Identifier">Response</span></a></pre></dt>
    1280. 

  1280.   <dd>
    1281. 

  1281.     
    1282. 

  1282.     
    1283. 

  1283.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/httpclient.nim#L1135" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1284. 

  1284. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/httpclient.nim#L1135" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1285. 

  1285. 

  1286.   </dd>
    1287. 

  1287. </div>
    1288. 

  1288. 

  1289. </div>
    1290. 

  1290. 

  1291.   </dl>
    1292. 

  1292. </div>
    1293. 

  1293. 

  1294.   </div>
    1295. 

  1295. </div>
    1296. 

  1296. 

  1297.       <div class="twelve-columns footer">
    1298. 

  1298.         <span class="nim-sprite"></span>
    1299. 

  1299.         <br>
    1300. 

  1300.         <small style="color: var(--hint);">Made with Nim. Generated: 2024-12-25 08:36:20 UTC</small>
    1301. 

  1301.       </div>
    1302. 

  1302.     </div>
    1303. 

  1303.   </div>
    1304. 

  1304.       <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    1305. 

  1305.     
    1306. 

  1306. </body>
    1307. 

  1307. </html>
    1308. 

  1308.