Inicio Explorar Axuda
Iniciar sesión
levovix
/
Nim
réplica de https://github.com/nim-lang/Nim
Seguir 1
Destacar 0
Fork 1
Ficheiros Incidencias 0 Wiki
Rama: gh-pages
Ramas Etiquetas
Nim
/
cgi.html

cgi.html 89 KB
Permalink Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982 
  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/cgi</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/cgi</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>
    55. 

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

  56. </li>
    57. 

  57. <li>
    58. 

  58.   <details open>
    59. 

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

  60.     <ul class="simple simple-toc-section">
    61. 

  61.       <li><a class="reference" href="#CgiError" title="CgiError = object of IOError">CgiError</a></li>
    62. 

  62. <li><a class="reference" href="#RequestMethod" title="RequestMethod = enum
    63. 

  63.   methodNone,               ## no REQUEST_METHOD environment variable
    64. 

  64.   methodPost,               ## query uses the POST method
    65. 

  65.   methodGet                  ## query uses the GET method">RequestMethod</a></li>
    66. 

  66. 

  67.     </ul>
    68. 

  68.   </details>
    69. 

  69. </li>
    70. 

  70. <li>
    71. 

  71.   <details open>
    72. 

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

  73.     <ul class="simple simple-toc-section">
    74. 

  74.       <ul class="simple nested-toc-section">cgiError
    75. 

  75.   <li><a class="reference" href="#cgiError%2Cstring" title="cgiError(msg: string)">cgiError(msg: string)</a></li>
    76. 

  76. 

  77. </ul>
    78. 

  78. <ul class="simple nested-toc-section">existsCookie
    79. 

  79.   <li><a class="reference" href="#existsCookie%2Cstring" title="existsCookie(name: string): bool">existsCookie(name: string): bool</a></li>
    80. 

  80. 

  81. </ul>
    82. 

  82. <ul class="simple nested-toc-section">getContentLength
    83. 

  83.   <li><a class="reference" href="#getContentLength" title="getContentLength(): string">getContentLength(): string</a></li>
    84. 

  84. 

  85. </ul>
    86. 

  86. <ul class="simple nested-toc-section">getContentType
    87. 

  87.   <li><a class="reference" href="#getContentType" title="getContentType(): string">getContentType(): string</a></li>
    88. 

  88. 

  89. </ul>
    90. 

  90. <ul class="simple nested-toc-section">getCookie
    91. 

  91.   <li><a class="reference" href="#getCookie%2Cstring" title="getCookie(name: string): string">getCookie(name: string): string</a></li>
    92. 

  92. 

  93. </ul>
    94. 

  94. <ul class="simple nested-toc-section">getDocumentRoot
    95. 

  95.   <li><a class="reference" href="#getDocumentRoot" title="getDocumentRoot(): string">getDocumentRoot(): string</a></li>
    96. 

  96. 

  97. </ul>
    98. 

  98. <ul class="simple nested-toc-section">getGatewayInterface
    99. 

  99.   <li><a class="reference" href="#getGatewayInterface" title="getGatewayInterface(): string">getGatewayInterface(): string</a></li>
    100. 

  100. 

  101. </ul>
    102. 

  102. <ul class="simple nested-toc-section">getHttpAccept
    103. 

  103.   <li><a class="reference" href="#getHttpAccept" title="getHttpAccept(): string">getHttpAccept(): string</a></li>
    104. 

  104. 

  105. </ul>
    106. 

  106. <ul class="simple nested-toc-section">getHttpAcceptCharset
    107. 

  107.   <li><a class="reference" href="#getHttpAcceptCharset" title="getHttpAcceptCharset(): string">getHttpAcceptCharset(): string</a></li>
    108. 

  108. 

  109. </ul>
    110. 

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

  111.   <li><a class="reference" href="#getHttpAcceptEncoding" title="getHttpAcceptEncoding(): string">getHttpAcceptEncoding(): string</a></li>
    112. 

  112. 

  113. </ul>
    114. 

  114. <ul class="simple nested-toc-section">getHttpAcceptLanguage
    115. 

  115.   <li><a class="reference" href="#getHttpAcceptLanguage" title="getHttpAcceptLanguage(): string">getHttpAcceptLanguage(): string</a></li>
    116. 

  116. 

  117. </ul>
    118. 

  118. <ul class="simple nested-toc-section">getHttpConnection
    119. 

  119.   <li><a class="reference" href="#getHttpConnection" title="getHttpConnection(): string">getHttpConnection(): string</a></li>
    120. 

  120. 

  121. </ul>
    122. 

  122. <ul class="simple nested-toc-section">getHttpCookie
    123. 

  123.   <li><a class="reference" href="#getHttpCookie" title="getHttpCookie(): string">getHttpCookie(): string</a></li>
    124. 

  124. 

  125. </ul>
    126. 

  126. <ul class="simple nested-toc-section">getHttpHost
    127. 

  127.   <li><a class="reference" href="#getHttpHost" title="getHttpHost(): string">getHttpHost(): string</a></li>
    128. 

  128. 

  129. </ul>
    130. 

  130. <ul class="simple nested-toc-section">getHttpReferer
    131. 

  131.   <li><a class="reference" href="#getHttpReferer" title="getHttpReferer(): string">getHttpReferer(): string</a></li>
    132. 

  132. 

  133. </ul>
    134. 

  134. <ul class="simple nested-toc-section">getHttpUserAgent
    135. 

  135.   <li><a class="reference" href="#getHttpUserAgent" title="getHttpUserAgent(): string">getHttpUserAgent(): string</a></li>
    136. 

  136. 

  137. </ul>
    138. 

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

  139.   <li><a class="reference" href="#getPathInfo" title="getPathInfo(): string">getPathInfo(): string</a></li>
    140. 

  140. 

  141. </ul>
    142. 

  142. <ul class="simple nested-toc-section">getPathTranslated
    143. 

  143.   <li><a class="reference" href="#getPathTranslated" title="getPathTranslated(): string">getPathTranslated(): string</a></li>
    144. 

  144. 

  145. </ul>
    146. 

  146. <ul class="simple nested-toc-section">getQueryString
    147. 

  147.   <li><a class="reference" href="#getQueryString" title="getQueryString(): string">getQueryString(): string</a></li>
    148. 

  148. 

  149. </ul>
    150. 

  150. <ul class="simple nested-toc-section">getRemoteAddr
    151. 

  151.   <li><a class="reference" href="#getRemoteAddr" title="getRemoteAddr(): string">getRemoteAddr(): string</a></li>
    152. 

  152. 

  153. </ul>
    154. 

  154. <ul class="simple nested-toc-section">getRemoteHost
    155. 

  155.   <li><a class="reference" href="#getRemoteHost" title="getRemoteHost(): string">getRemoteHost(): string</a></li>
    156. 

  156. 

  157. </ul>
    158. 

  158. <ul class="simple nested-toc-section">getRemoteIdent
    159. 

  159.   <li><a class="reference" href="#getRemoteIdent" title="getRemoteIdent(): string">getRemoteIdent(): string</a></li>
    160. 

  160. 

  161. </ul>
    162. 

  162. <ul class="simple nested-toc-section">getRemotePort
    163. 

  163.   <li><a class="reference" href="#getRemotePort" title="getRemotePort(): string">getRemotePort(): string</a></li>
    164. 

  164. 

  165. </ul>
    166. 

  166. <ul class="simple nested-toc-section">getRemoteUser
    167. 

  167.   <li><a class="reference" href="#getRemoteUser" title="getRemoteUser(): string">getRemoteUser(): string</a></li>
    168. 

  168. 

  169. </ul>
    170. 

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

  171.   <li><a class="reference" href="#getRequestMethod" title="getRequestMethod(): string">getRequestMethod(): string</a></li>
    172. 

  172. 

  173. </ul>
    174. 

  174. <ul class="simple nested-toc-section">getRequestURI
    175. 

  175.   <li><a class="reference" href="#getRequestURI" title="getRequestURI(): string">getRequestURI(): string</a></li>
    176. 

  176. 

  177. </ul>
    178. 

  178. <ul class="simple nested-toc-section">getScriptFilename
    179. 

  179.   <li><a class="reference" href="#getScriptFilename" title="getScriptFilename(): string">getScriptFilename(): string</a></li>
    180. 

  180. 

  181. </ul>
    182. 

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

  183.   <li><a class="reference" href="#getScriptName" title="getScriptName(): string">getScriptName(): string</a></li>
    184. 

  184. 

  185. </ul>
    186. 

  186. <ul class="simple nested-toc-section">getServerAddr
    187. 

  187.   <li><a class="reference" href="#getServerAddr" title="getServerAddr(): string">getServerAddr(): string</a></li>
    188. 

  188. 

  189. </ul>
    190. 

  190. <ul class="simple nested-toc-section">getServerAdmin
    191. 

  191.   <li><a class="reference" href="#getServerAdmin" title="getServerAdmin(): string">getServerAdmin(): string</a></li>
    192. 

  192. 

  193. </ul>
    194. 

  194. <ul class="simple nested-toc-section">getServerName
    195. 

  195.   <li><a class="reference" href="#getServerName" title="getServerName(): string">getServerName(): string</a></li>
    196. 

  196. 

  197. </ul>
    198. 

  198. <ul class="simple nested-toc-section">getServerPort
    199. 

  199.   <li><a class="reference" href="#getServerPort" title="getServerPort(): string">getServerPort(): string</a></li>
    200. 

  200. 

  201. </ul>
    202. 

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

  203.   <li><a class="reference" href="#getServerProtocol" title="getServerProtocol(): string">getServerProtocol(): string</a></li>
    204. 

  204. 

  205. </ul>
    206. 

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

  207.   <li><a class="reference" href="#getServerSignature" title="getServerSignature(): string">getServerSignature(): string</a></li>
    208. 

  208. 

  209. </ul>
    210. 

  210. <ul class="simple nested-toc-section">getServerSoftware
    211. 

  211.   <li><a class="reference" href="#getServerSoftware" title="getServerSoftware(): string">getServerSoftware(): string</a></li>
    212. 

  212. 

  213. </ul>
    214. 

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

  215.   <li><a class="reference" href="#readData%2Cset%5BRequestMethod%5D" title="readData(allowedMethods: set[RequestMethod] = {methodNone, methodPost, methodGet}): StringTableRef">readData(allowedMethods: set[RequestMethod] = {methodNone, methodPost, methodGet}): StringTableRef</a></li>
    216. 

  216. <li><a class="reference" href="#readData%2Cstring" title="readData(data: string): StringTableRef">readData(data: string): StringTableRef</a></li>
    217. 

  217. 

  218. </ul>
    219. 

  219. <ul class="simple nested-toc-section">setCookie
    220. 

  220.   <li><a class="reference" href="#setCookie%2Cstring%2Cstring" title="setCookie(name, value: string)">setCookie(name, value: string)</a></li>
    221. 

  221. 

  222. </ul>
    223. 

  223. <ul class="simple nested-toc-section">setStackTraceStdout
    224. 

  224.   <li><a class="reference" href="#setStackTraceStdout" title="setStackTraceStdout()">setStackTraceStdout()</a></li>
    225. 

  225. 

  226. </ul>
    227. 

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

  228.   <li><a class="reference" href="#setTestData%2Cvarargs%5Bstring%5D" title="setTestData(keysvalues: varargs[string])">setTestData(keysvalues: varargs[string])</a></li>
    229. 

  229. 

  230. </ul>
    231. 

  231. <ul class="simple nested-toc-section">validateData
    232. 

  232.   <li><a class="reference" href="#validateData%2CStringTableRef%2Cvarargs%5Bstring%5D" title="validateData(data: StringTableRef; validKeys: varargs[string])">validateData(data: StringTableRef; validKeys: varargs[string])</a></li>
    233. 

  233. 

  234. </ul>
    235. 

  235. <ul class="simple nested-toc-section">writeContentType
    236. 

  236.   <li><a class="reference" href="#writeContentType" title="writeContentType()">writeContentType()</a></li>
    237. 

  237. 

  238. </ul>
    239. 

  239. <ul class="simple nested-toc-section">writeErrorMessage
    240. 

  240.   <li><a class="reference" href="#writeErrorMessage%2Cstring" title="writeErrorMessage(data: string)">writeErrorMessage(data: string)</a></li>
    241. 

  241. 

  242. </ul>
    243. 

  243. <ul class="simple nested-toc-section">xmlEncode
    244. 

  244.   <li><a class="reference" href="#xmlEncode%2Cstring" title="xmlEncode(s: string): string">xmlEncode(s: string): string</a></li>
    245. 

  245. 

  246. </ul>
    247. 

  247. 

  248.     </ul>
    249. 

  249.   </details>
    250. 

  250. </li>
    251. 

  251. <li>
    252. 

  252.   <details open>
    253. 

  253.     <summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
    254. 

  254.     <ul class="simple simple-toc-section">
    255. 

  255.       <ul class="simple nested-toc-section">decodeData
    256. 

  256.   <li><a class="reference" href="#decodeData.i%2Cset%5BRequestMethod%5D" title="decodeData(allowedMethods: set[RequestMethod] = {methodNone, methodPost,
    257. 

  257.     methodGet}): tuple[key, value: string]">decodeData(allowedMethods: set[RequestMethod] = {methodNone, methodPost,
    258. 

  258.     methodGet}): tuple[key, value: string]</a></li>
    259. 

  259. <li><a class="reference" href="#decodeData.i%2Cstring" title="decodeData(data: string): tuple[key, value: string]">decodeData(data: string): tuple[key, value: string]</a></li>
    260. 

  260. 

  261. </ul>
    262. 

  262. 

  263.     </ul>
    264. 

  264.   </details>
    265. 

  265. </li>
    266. 

  266. 

  267. </ul>
    268. 

  268. 

  269.   </div>
    270. 

  270.   <div class="nine columns" id="content">
    271. 

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

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

  273. 

  274.     <div id="tocRoot"></div>
    275. 

  275.     
    276. 

  276.     <p class="module-desc"><p>This module implements helper procs for CGI applications. Example:</p>
    277. 

  277. <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">strtabs</span><span class="Punctuation">,</span> <span class="Identifier">cgi</span><span class="Punctuation">]</span>
    278. 

  278. 

  279. <span class="Comment"># Fill the values when debugging:</span>
    280. 

  280. <span class="Keyword">when</span> <span class="Identifier">debug</span><span class="Punctuation">:</span>
    281. 

  281.   <span class="Identifier">setTestData</span><span class="Punctuation">(</span><span class="StringLit">&quot;name&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Klaus&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;password&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;123456&quot;</span><span class="Punctuation">)</span>
    282. 

  282. <span class="Comment"># read the data into `myData`</span>
    283. 

  283. <span class="Keyword">var</span> <span class="Identifier">myData</span> <span class="Operator">=</span> <span class="Identifier">readData</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    284. 

  284. <span class="Comment"># check that the data's variable names are &quot;name&quot; or &quot;password&quot;</span>
    285. 

  285. <span class="Identifier">validateData</span><span class="Punctuation">(</span><span class="Identifier">myData</span><span class="Punctuation">,</span> <span class="StringLit">&quot;name&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;password&quot;</span><span class="Punctuation">)</span>
    286. 

  286. <span class="Comment"># start generating content:</span>
    287. 

  287. <span class="Identifier">writeContentType</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    288. 

  288. <span class="Comment"># generate content:</span>
    289. 

  289. <span class="Identifier">write</span><span class="Punctuation">(</span><span class="Identifier">stdout</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&lt;!DOCTYPE HTML PUBLIC </span><span class="EscapeSequence">\&quot;</span><span class="StringLit">-//W3C//DTD HTML 4.01//EN</span><span class="EscapeSequence">\&quot;</span><span class="StringLit">&gt;</span><span class="EscapeSequence">\n</span><span class="StringLit">&quot;</span><span class="Punctuation">)</span>
    290. 

  290. <span class="Identifier">write</span><span class="Punctuation">(</span><span class="Identifier">stdout</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&lt;html&gt;&lt;head&gt;&lt;title&gt;Test&lt;/title&gt;&lt;/head&gt;&lt;body&gt;</span><span class="EscapeSequence">\n</span><span class="StringLit">&quot;</span><span class="Punctuation">)</span>
    291. 

  291. <span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="Identifier">stdout</span><span class="Punctuation">,</span> <span class="StringLit">&quot;your name: &quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">myData</span><span class="Punctuation">[</span><span class="StringLit">&quot;name&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    292. 

  292. <span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="Identifier">stdout</span><span class="Punctuation">,</span> <span class="StringLit">&quot;your password: &quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">myData</span><span class="Punctuation">[</span><span class="StringLit">&quot;password&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    293. 

  293. <span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="Identifier">stdout</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&lt;/body&gt;&lt;/html&gt;&quot;</span><span class="Punctuation">)</span></pre></p>
    294. 

  294. </p>
    295. 

  295.     <div class="section" id="6">
    296. 

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

  297.   <dl class="item">
    298. 

  298.     <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="os.html">os</a>, <a class="reference external" href="strtabs.html">strtabs</a>, <a class="reference external" href="cookies.html">cookies</a>, <a class="reference external" href="uri.html">uri</a>, <a class="reference external" href="syncio.html">syncio</a>
    299. 

  299.   </dl>
    300. 

  300. </div>
    301. 

  301. <div class="section" id="7">
    302. 

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

  303.   <dl class="item">
    304. 

  304.     <div id="CgiError">
    305. 

  305.   <dt><pre><a href="cgi.html#CgiError"><span class="Identifier">CgiError</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>
    306. 

  306.   <dd>
    307. 

  307.     
    308. 

  308.     Exception that is raised if a CGI error occurs.
    309. 

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

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

  311. 

  312.   </dd>
    313. 

  313. </div>
    314. 

  314. <div id="RequestMethod">
    315. 

  315.   <dt><pre><a href="cgi.html#RequestMethod"><span class="Identifier">RequestMethod</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    316. 

  316.   <span class="Identifier">methodNone</span><span class="Other">,</span>               <span class="Comment">## no REQUEST_METHOD environment variable</span>
    317. 

  317.   <span class="Identifier">methodPost</span><span class="Other">,</span>               <span class="Comment">## query uses the POST method</span>
    318. 

  318.   <span class="Identifier">methodGet</span>                  <span class="Comment">## query uses the GET method</span></pre></dt>
    319. 

  319.   <dd>
    320. 

  320.     
    321. 

  321.     The used request method.
    322. 

  322.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L59" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    323. 

  323. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L59" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    324. 

  324. 

  325.   </dd>
    326. 

  326. </div>
    327. 

  327. 

  328.   </dl>
    329. 

  329. </div>
    330. 

  330. <div class="section" id="12">
    331. 

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

  332.   <dl class="item">
    333. 

  333.     <div id="cgiError-procs-all">
    334. 

  334.   <div id="cgiError,string">
    335. 

  335.   <dt><pre><span class="Keyword">proc</span> <a href="#cgiError%2Cstring"><span class="Identifier">cgiError</span></a><span class="Other">(</span><span class="Identifier">msg</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span class="Identifier">noreturn</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">CgiError</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>
    336. 

  336.   <dd>
    337. 

  337.     
    338. 

  338.     Raises a <tt class="docutils literal"><span class="pre"><span class="Identifier">CgiError</span></span></tt> exception with message <tt class="docutils literal"><span class="pre"><span class="Identifier">msg</span></span></tt>.
    339. 

  339.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L64" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    340. 

  340. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L64" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    341. 

  341. 

  342.   </dd>
    343. 

  343. </div>
    344. 

  344. 

  345. </div>
    346. 

  346. <div id="existsCookie-procs-all">
    347. 

  347.   <div id="existsCookie,string">
    348. 

  348.   <dt><pre><span class="Keyword">proc</span> <a href="#existsCookie%2Cstring"><span class="Identifier">existsCookie</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><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</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="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    349. 

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

  350.   <dd>
    351. 

  351.     
    352. 

  352.     Checks if a cookie of <tt class="docutils literal"><span class="pre"><span class="Identifier">name</span></span></tt> exists.
    353. 

  353.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L314" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    354. 

  354. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L314" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    355. 

  355. 

  356.   </dd>
    357. 

  357. </div>
    358. 

  358. 

  359. </div>
    360. 

  360. <div id="getContentLength-procs-all">
    361. 

  361.   <div id="getContentLength">
    362. 

  362.   <dt><pre><span class="Keyword">proc</span> <a href="#getContentLength"><span class="Identifier">getContentLength</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    363. 

  363.   <dd>
    364. 

  364.     
    365. 

  365.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">CONTENT_LENGTH</span></span></tt> environment variable.
    366. 

  366.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L125" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    367. 

  367. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L125" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    368. 

  368. 

  369.   </dd>
    370. 

  370. </div>
    371. 

  371. 

  372. </div>
    373. 

  373. <div id="getContentType-procs-all">
    374. 

  374.   <div id="getContentType">
    375. 

  375.   <dt><pre><span class="Keyword">proc</span> <a href="#getContentType"><span class="Identifier">getContentType</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    376. 

  376.   <dd>
    377. 

  377.     
    378. 

  378.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">CONTENT_TYPE</span></span></tt> environment variable.
    379. 

  379.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L129" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    380. 

  380. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L129" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    381. 

  381. 

  382.   </dd>
    383. 

  383. </div>
    384. 

  384. 

  385. </div>
    386. 

  386. <div id="getCookie-procs-all">
    387. 

  387.   <div id="getCookie,string">
    388. 

  388.   <dt><pre><span class="Keyword">proc</span> <a href="#getCookie%2Cstring"><span class="Identifier">getCookie</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><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="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    389. 

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

  390.   <dd>
    391. 

  391.     
    392. 

  392.     Gets a cookie. If no cookie of <tt class="docutils literal"><span class="pre"><span class="Identifier">name</span></span></tt> exists, &quot;&quot; is returned.
    393. 

  393.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L309" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    394. 

  394. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L309" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    395. 

  395. 

  396.   </dd>
    397. 

  397. </div>
    398. 

  398. 

  399. </div>
    400. 

  400. <div id="getDocumentRoot-procs-all">
    401. 

  401.   <div id="getDocumentRoot">
    402. 

  402.   <dt><pre><span class="Keyword">proc</span> <a href="#getDocumentRoot"><span class="Identifier">getDocumentRoot</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    403. 

  403.   <dd>
    404. 

  404.     
    405. 

  405.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">DOCUMENT_ROOT</span></span></tt> environment variable.
    406. 

  406.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L133" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    407. 

  407. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L133" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    408. 

  408. 

  409.   </dd>
    410. 

  410. </div>
    411. 

  411. 

  412. </div>
    413. 

  413. <div id="getGatewayInterface-procs-all">
    414. 

  414.   <div id="getGatewayInterface">
    415. 

  415.   <dt><pre><span class="Keyword">proc</span> <a href="#getGatewayInterface"><span class="Identifier">getGatewayInterface</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    416. 

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

  417.   <dd>
    418. 

  418.     
    419. 

  419.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">GATEWAY_INTERFACE</span></span></tt> environment variable.
    420. 

  420.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L137" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    421. 

  421. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L137" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    422. 

  422. 

  423.   </dd>
    424. 

  424. </div>
    425. 

  425. 

  426. </div>
    427. 

  427. <div id="getHttpAccept-procs-all">
    428. 

  428.   <div id="getHttpAccept">
    429. 

  429.   <dt><pre><span class="Keyword">proc</span> <a href="#getHttpAccept"><span class="Identifier">getHttpAccept</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    430. 

  430.   <dd>
    431. 

  431.     
    432. 

  432.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">HTTP_ACCEPT</span></span></tt> environment variable.
    433. 

  433.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L141" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    434. 

  434. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L141" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    435. 

  435. 

  436.   </dd>
    437. 

  437. </div>
    438. 

  438. 

  439. </div>
    440. 

  440. <div id="getHttpAcceptCharset-procs-all">
    441. 

  441.   <div id="getHttpAcceptCharset">
    442. 

  442.   <dt><pre><span class="Keyword">proc</span> <a href="#getHttpAcceptCharset"><span class="Identifier">getHttpAcceptCharset</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    443. 

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

  444.   <dd>
    445. 

  445.     
    446. 

  446.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">HTTP_ACCEPT_CHARSET</span></span></tt> environment variable.
    447. 

  447.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L145" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    448. 

  448. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L145" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    449. 

  449. 

  450.   </dd>
    451. 

  451. </div>
    452. 

  452. 

  453. </div>
    454. 

  454. <div id="getHttpAcceptEncoding-procs-all">
    455. 

  455.   <div id="getHttpAcceptEncoding">
    456. 

  456.   <dt><pre><span class="Keyword">proc</span> <a href="#getHttpAcceptEncoding"><span class="Identifier">getHttpAcceptEncoding</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    457. 

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

  458.   <dd>
    459. 

  459.     
    460. 

  460.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">HTTP_ACCEPT_ENCODING</span></span></tt> environment variable.
    461. 

  461.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L149" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    462. 

  462. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L149" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    463. 

  463. 

  464.   </dd>
    465. 

  465. </div>
    466. 

  466. 

  467. </div>
    468. 

  468. <div id="getHttpAcceptLanguage-procs-all">
    469. 

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

  470.   <dt><pre><span class="Keyword">proc</span> <a href="#getHttpAcceptLanguage"><span class="Identifier">getHttpAcceptLanguage</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    471. 

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

  472.   <dd>
    473. 

  473.     
    474. 

  474.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">HTTP_ACCEPT_LANGUAGE</span></span></tt> environment variable.
    475. 

  475.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L153" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    476. 

  476. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L153" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    477. 

  477. 

  478.   </dd>
    479. 

  479. </div>
    480. 

  480. 

  481. </div>
    482. 

  482. <div id="getHttpConnection-procs-all">
    483. 

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

  484.   <dt><pre><span class="Keyword">proc</span> <a href="#getHttpConnection"><span class="Identifier">getHttpConnection</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    485. 

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

  486.   <dd>
    487. 

  487.     
    488. 

  488.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">HTTP_CONNECTION</span></span></tt> environment variable.
    489. 

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

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

  491. 

  492.   </dd>
    493. 

  493. </div>
    494. 

  494. 

  495. </div>
    496. 

  496. <div id="getHttpCookie-procs-all">
    497. 

  497.   <div id="getHttpCookie">
    498. 

  498.   <dt><pre><span class="Keyword">proc</span> <a href="#getHttpCookie"><span class="Identifier">getHttpCookie</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    499. 

  499.   <dd>
    500. 

  500.     
    501. 

  501.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">HTTP_COOKIE</span></span></tt> environment variable.
    502. 

  502.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L161" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    503. 

  503. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L161" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    504. 

  504. 

  505.   </dd>
    506. 

  506. </div>
    507. 

  507. 

  508. </div>
    509. 

  509. <div id="getHttpHost-procs-all">
    510. 

  510.   <div id="getHttpHost">
    511. 

  511.   <dt><pre><span class="Keyword">proc</span> <a href="#getHttpHost"><span class="Identifier">getHttpHost</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    512. 

  512.   <dd>
    513. 

  513.     
    514. 

  514.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">HTTP_HOST</span></span></tt> environment variable.
    515. 

  515.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L165" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    516. 

  516. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L165" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    517. 

  517. 

  518.   </dd>
    519. 

  519. </div>
    520. 

  520. 

  521. </div>
    522. 

  522. <div id="getHttpReferer-procs-all">
    523. 

  523.   <div id="getHttpReferer">
    524. 

  524.   <dt><pre><span class="Keyword">proc</span> <a href="#getHttpReferer"><span class="Identifier">getHttpReferer</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    525. 

  525.   <dd>
    526. 

  526.     
    527. 

  527.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">HTTP_REFERER</span></span></tt> environment variable.
    528. 

  528.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L169" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    529. 

  529. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L169" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    530. 

  530. 

  531.   </dd>
    532. 

  532. </div>
    533. 

  533. 

  534. </div>
    535. 

  535. <div id="getHttpUserAgent-procs-all">
    536. 

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

  537.   <dt><pre><span class="Keyword">proc</span> <a href="#getHttpUserAgent"><span class="Identifier">getHttpUserAgent</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    538. 

  538.   <dd>
    539. 

  539.     
    540. 

  540.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">HTTP_USER_AGENT</span></span></tt> environment variable.
    541. 

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

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

  543. 

  544.   </dd>
    545. 

  545. </div>
    546. 

  546. 

  547. </div>
    548. 

  548. <div id="getPathInfo-procs-all">
    549. 

  549.   <div id="getPathInfo">
    550. 

  550.   <dt><pre><span class="Keyword">proc</span> <a href="#getPathInfo"><span class="Identifier">getPathInfo</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    551. 

  551.   <dd>
    552. 

  552.     
    553. 

  553.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">PATH_INFO</span></span></tt> environment variable.
    554. 

  554.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L177" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    555. 

  555. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L177" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    556. 

  556. 

  557.   </dd>
    558. 

  558. </div>
    559. 

  559. 

  560. </div>
    561. 

  561. <div id="getPathTranslated-procs-all">
    562. 

  562.   <div id="getPathTranslated">
    563. 

  563.   <dt><pre><span class="Keyword">proc</span> <a href="#getPathTranslated"><span class="Identifier">getPathTranslated</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    564. 

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

  565.   <dd>
    566. 

  566.     
    567. 

  567.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">PATH_TRANSLATED</span></span></tt> environment variable.
    568. 

  568.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L181" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    569. 

  569. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L181" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    570. 

  570. 

  571.   </dd>
    572. 

  572. </div>
    573. 

  573. 

  574. </div>
    575. 

  575. <div id="getQueryString-procs-all">
    576. 

  576.   <div id="getQueryString">
    577. 

  577.   <dt><pre><span class="Keyword">proc</span> <a href="#getQueryString"><span class="Identifier">getQueryString</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    578. 

  578.   <dd>
    579. 

  579.     
    580. 

  580.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">QUERY_STRING</span></span></tt> environment variable.
    581. 

  581.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L185" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    582. 

  582. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L185" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    583. 

  583. 

  584.   </dd>
    585. 

  585. </div>
    586. 

  586. 

  587. </div>
    588. 

  588. <div id="getRemoteAddr-procs-all">
    589. 

  589.   <div id="getRemoteAddr">
    590. 

  590.   <dt><pre><span class="Keyword">proc</span> <a href="#getRemoteAddr"><span class="Identifier">getRemoteAddr</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    591. 

  591.   <dd>
    592. 

  592.     
    593. 

  593.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">REMOTE_ADDR</span></span></tt> environment variable.
    594. 

  594.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L189" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    595. 

  595. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L189" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    596. 

  596. 

  597.   </dd>
    598. 

  598. </div>
    599. 

  599. 

  600. </div>
    601. 

  601. <div id="getRemoteHost-procs-all">
    602. 

  602.   <div id="getRemoteHost">
    603. 

  603.   <dt><pre><span class="Keyword">proc</span> <a href="#getRemoteHost"><span class="Identifier">getRemoteHost</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    604. 

  604.   <dd>
    605. 

  605.     
    606. 

  606.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">REMOTE_HOST</span></span></tt> environment variable.
    607. 

  607.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L193" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    608. 

  608. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L193" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    609. 

  609. 

  610.   </dd>
    611. 

  611. </div>
    612. 

  612. 

  613. </div>
    614. 

  614. <div id="getRemoteIdent-procs-all">
    615. 

  615.   <div id="getRemoteIdent">
    616. 

  616.   <dt><pre><span class="Keyword">proc</span> <a href="#getRemoteIdent"><span class="Identifier">getRemoteIdent</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    617. 

  617.   <dd>
    618. 

  618.     
    619. 

  619.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">REMOTE_IDENT</span></span></tt> environment variable.
    620. 

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

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

  622. 

  623.   </dd>
    624. 

  624. </div>
    625. 

  625. 

  626. </div>
    627. 

  627. <div id="getRemotePort-procs-all">
    628. 

  628.   <div id="getRemotePort">
    629. 

  629.   <dt><pre><span class="Keyword">proc</span> <a href="#getRemotePort"><span class="Identifier">getRemotePort</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    630. 

  630.   <dd>
    631. 

  631.     
    632. 

  632.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">REMOTE_PORT</span></span></tt> environment variable.
    633. 

  633.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L201" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    634. 

  634. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L201" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    635. 

  635. 

  636.   </dd>
    637. 

  637. </div>
    638. 

  638. 

  639. </div>
    640. 

  640. <div id="getRemoteUser-procs-all">
    641. 

  641.   <div id="getRemoteUser">
    642. 

  642.   <dt><pre><span class="Keyword">proc</span> <a href="#getRemoteUser"><span class="Identifier">getRemoteUser</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    643. 

  643.   <dd>
    644. 

  644.     
    645. 

  645.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">REMOTE_USER</span></span></tt> environment variable.
    646. 

  646.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L205" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    647. 

  647. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L205" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    648. 

  648. 

  649.   </dd>
    650. 

  650. </div>
    651. 

  651. 

  652. </div>
    653. 

  653. <div id="getRequestMethod-procs-all">
    654. 

  654.   <div id="getRequestMethod">
    655. 

  655.   <dt><pre><span class="Keyword">proc</span> <a href="#getRequestMethod"><span class="Identifier">getRequestMethod</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    656. 

  656.   <dd>
    657. 

  657.     
    658. 

  658.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">REQUEST_METHOD</span></span></tt> environment variable.
    659. 

  659.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L209" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    660. 

  660. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L209" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    661. 

  661. 

  662.   </dd>
    663. 

  663. </div>
    664. 

  664. 

  665. </div>
    666. 

  666. <div id="getRequestURI-procs-all">
    667. 

  667.   <div id="getRequestURI">
    668. 

  668.   <dt><pre><span class="Keyword">proc</span> <a href="#getRequestURI"><span class="Identifier">getRequestURI</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    669. 

  669.   <dd>
    670. 

  670.     
    671. 

  671.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">REQUEST_URI</span></span></tt> environment variable.
    672. 

  672.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L213" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    673. 

  673. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L213" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    674. 

  674. 

  675.   </dd>
    676. 

  676. </div>
    677. 

  677. 

  678. </div>
    679. 

  679. <div id="getScriptFilename-procs-all">
    680. 

  680.   <div id="getScriptFilename">
    681. 

  681.   <dt><pre><span class="Keyword">proc</span> <a href="#getScriptFilename"><span class="Identifier">getScriptFilename</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    682. 

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

  683.   <dd>
    684. 

  684.     
    685. 

  685.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">SCRIPT_FILENAME</span></span></tt> environment variable.
    686. 

  686.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L217" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    687. 

  687. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L217" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    688. 

  688. 

  689.   </dd>
    690. 

  690. </div>
    691. 

  691. 

  692. </div>
    693. 

  693. <div id="getScriptName-procs-all">
    694. 

  694.   <div id="getScriptName">
    695. 

  695.   <dt><pre><span class="Keyword">proc</span> <a href="#getScriptName"><span class="Identifier">getScriptName</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    696. 

  696.   <dd>
    697. 

  697.     
    698. 

  698.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">SCRIPT_NAME</span></span></tt> environment variable.
    699. 

  699.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L221" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    700. 

  700. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L221" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    701. 

  701. 

  702.   </dd>
    703. 

  703. </div>
    704. 

  704. 

  705. </div>
    706. 

  706. <div id="getServerAddr-procs-all">
    707. 

  707.   <div id="getServerAddr">
    708. 

  708.   <dt><pre><span class="Keyword">proc</span> <a href="#getServerAddr"><span class="Identifier">getServerAddr</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    709. 

  709.   <dd>
    710. 

  710.     
    711. 

  711.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">SERVER_ADDR</span></span></tt> environment variable.
    712. 

  712.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L225" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    713. 

  713. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L225" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    714. 

  714. 

  715.   </dd>
    716. 

  716. </div>
    717. 

  717. 

  718. </div>
    719. 

  719. <div id="getServerAdmin-procs-all">
    720. 

  720.   <div id="getServerAdmin">
    721. 

  721.   <dt><pre><span class="Keyword">proc</span> <a href="#getServerAdmin"><span class="Identifier">getServerAdmin</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    722. 

  722.   <dd>
    723. 

  723.     
    724. 

  724.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">SERVER_ADMIN</span></span></tt> environment variable.
    725. 

  725.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L229" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    726. 

  726. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L229" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    727. 

  727. 

  728.   </dd>
    729. 

  729. </div>
    730. 

  730. 

  731. </div>
    732. 

  732. <div id="getServerName-procs-all">
    733. 

  733.   <div id="getServerName">
    734. 

  734.   <dt><pre><span class="Keyword">proc</span> <a href="#getServerName"><span class="Identifier">getServerName</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    735. 

  735.   <dd>
    736. 

  736.     
    737. 

  737.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">SERVER_NAME</span></span></tt> environment variable.
    738. 

  738.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L233" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    739. 

  739. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L233" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    740. 

  740. 

  741.   </dd>
    742. 

  742. </div>
    743. 

  743. 

  744. </div>
    745. 

  745. <div id="getServerPort-procs-all">
    746. 

  746.   <div id="getServerPort">
    747. 

  747.   <dt><pre><span class="Keyword">proc</span> <a href="#getServerPort"><span class="Identifier">getServerPort</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</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>
    748. 

  748.   <dd>
    749. 

  749.     
    750. 

  750.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">SERVER_PORT</span></span></tt> environment variable.
    751. 

  751.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L237" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    752. 

  752. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L237" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    753. 

  753. 

  754.   </dd>
    755. 

  755. </div>
    756. 

  756. 

  757. </div>
    758. 

  758. <div id="getServerProtocol-procs-all">
    759. 

  759.   <div id="getServerProtocol">
    760. 

  760.   <dt><pre><span class="Keyword">proc</span> <a href="#getServerProtocol"><span class="Identifier">getServerProtocol</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    761. 

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

  762.   <dd>
    763. 

  763.     
    764. 

  764.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">SERVER_PROTOCOL</span></span></tt> environment variable.
    765. 

  765.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L241" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    766. 

  766. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L241" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    767. 

  767. 

  768.   </dd>
    769. 

  769. </div>
    770. 

  770. 

  771. </div>
    772. 

  772. <div id="getServerSignature-procs-all">
    773. 

  773.   <div id="getServerSignature">
    774. 

  774.   <dt><pre><span class="Keyword">proc</span> <a href="#getServerSignature"><span class="Identifier">getServerSignature</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    775. 

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

  776.   <dd>
    777. 

  777.     
    778. 

  778.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">SERVER_SIGNATURE</span></span></tt> environment variable.
    779. 

  779.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L245" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    780. 

  780. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L245" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    781. 

  781. 

  782.   </dd>
    783. 

  783. </div>
    784. 

  784. 

  785. </div>
    786. 

  786. <div id="getServerSoftware-procs-all">
    787. 

  787.   <div id="getServerSoftware">
    788. 

  788.   <dt><pre><span class="Keyword">proc</span> <a href="#getServerSoftware"><span class="Identifier">getServerSoftware</span></a><span class="Other">(</span><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="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    789. 

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

  790.   <dd>
    791. 

  791.     
    792. 

  792.     Returns contents of the <tt class="docutils literal"><span class="pre"><span class="Identifier">SERVER_SOFTWARE</span></span></tt> environment variable.
    793. 

  793.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L249" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    794. 

  794. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L249" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    795. 

  795. 

  796.   </dd>
    797. 

  797. </div>
    798. 

  798. 

  799. </div>
    800. 

  800. <div id="readData-procs-all">
    801. 

  801.   <div id="readData,set[RequestMethod]">
    802. 

  802.   <dt><pre><span class="Keyword">proc</span> <a href="#readData%2Cset%5BRequestMethod%5D"><span class="Identifier">readData</span></a><span class="Other">(</span><span class="Identifier">allowedMethods</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="cgi.html#RequestMethod"><span class="Identifier">RequestMethod</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">methodNone</span><span class="Other">,</span> <span class="Identifier">methodPost</span><span class="Other">,</span>
    803. 

  803.     <span class="Identifier">methodGet</span><span class="Other">}</span><span class="Other">)</span><span class="Other">:</span> <a href="strtabs.html#StringTableRef"><span class="Identifier">StringTableRef</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">CgiError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    804. 

  804.                                   <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadEnvEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    805. 

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

  806.   <dd>
    807. 

  807.     
    808. 

  808.     Reads CGI data. If the client does not use a method listed in the <tt class="docutils literal"><span class="pre"><span class="Identifier">allowedMethods</span></span></tt> set, a <tt class="docutils literal"><span class="pre"><span class="Identifier">CgiError</span></span></tt> exception is raised.
    809. 

  809.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L104" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    810. 

  810. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L104" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    811. 

  811. 

  812.   </dd>
    813. 

  813. </div>
    814. 

  814. <div id="readData,string">
    815. 

  815.   <dt><pre><span class="Keyword">proc</span> <a href="#readData%2Cstring"><span class="Identifier">readData</span></a><span class="Other">(</span><span class="Identifier">data</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="strtabs.html#StringTableRef"><span class="Identifier">StringTableRef</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>
    816. 

  816.   <dd>
    817. 

  817.     
    818. 

  818.     Reads CGI data from a string.
    819. 

  819.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L112" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    820. 

  820. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L112" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    821. 

  821. 

  822.   </dd>
    823. 

  823. </div>
    824. 

  824. 

  825. </div>
    826. 

  826. <div id="setCookie-procs-all">
    827. 

  827.   <div id="setCookie,string,string">
    828. 

  828.   <dt><pre><span class="Keyword">proc</span> <a href="#setCookie%2Cstring%2Cstring"><span class="Identifier">setCookie</span></a><span class="Other">(</span><span class="Identifier">name</span><span class="Other">,</span> <span class="Identifier">value</span><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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</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">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    829. 

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

  830.   <dd>
    831. 

  831.     
    832. 

  832.     Sets a cookie.
    833. 

  833.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L302" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    834. 

  834. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L302" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    835. 

  835. 

  836.   </dd>
    837. 

  837. </div>
    838. 

  838. 

  839. </div>
    840. 

  840. <div id="setStackTraceStdout-procs-all">
    841. 

  841.   <div id="setStackTraceStdout">
    842. 

  842.   <dt><pre><span class="Keyword">proc</span> <a href="#setStackTraceStdout"><span class="Identifier">setStackTraceStdout</span></a><span class="Other">(</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    843. 

  843.   <dd>
    844. 

  844.     
    845. 

  845.     Makes Nim output stacktraces to stdout, instead of server log.
    846. 

  846.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L298" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    847. 

  847. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L298" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    848. 

  848. 

  849.   </dd>
    850. 

  850. </div>
    851. 

  851. 

  852. </div>
    853. 

  853. <div id="setTestData-procs-all">
    854. 

  854.   <div id="setTestData,varargs[string]">
    855. 

  855.   <dt><pre><span class="Keyword">proc</span> <a href="#setTestData%2Cvarargs%5Bstring%5D"><span class="Identifier">setTestData</span></a><span class="Other">(</span><span class="Identifier">keysvalues</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</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">OSError</span><span class="Other">]</span><span class="Other">,</span>
    856. 

  856.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteEnvEffect</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>
    857. 

  857.   <dd>
    858. 

  858.     
    859. 

  859.     <p>Fills the appropriate environment variables to test your CGI application. This can only simulate the 'GET' request method. <tt class="docutils literal"><span class="pre"><span class="Identifier">keysvalues</span></span></tt> should provide embedded (name, value)-pairs. Example:</p>
    860. 

  860. <p><pre class="listing"><span class="Identifier">setTestData</span><span class="Punctuation">(</span><span class="StringLit">&quot;name&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Hanz&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;password&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;12345&quot;</span><span class="Punctuation">)</span></pre></p>
    861. 

  861. 

  862.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L253" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    863. 

  863. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L253" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    864. 

  864. 

  865.   </dd>
    866. 

  866. </div>
    867. 

  867. 

  868. </div>
    869. 

  869. <div id="validateData-procs-all">
    870. 

  870.   <div id="validateData,StringTableRef,varargs[string]">
    871. 

  871.   <dt><pre><span class="Keyword">proc</span> <a href="#validateData%2CStringTableRef%2Cvarargs%5Bstring%5D"><span class="Identifier">validateData</span></a><span class="Other">(</span><span class="Identifier">data</span><span class="Other">:</span> <a href="strtabs.html#StringTableRef"><span class="Identifier">StringTableRef</span></a><span class="Other">;</span> <span class="Identifier">validKeys</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">)</span> {.
    872. 

  872.     <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">CgiError</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>
    873. 

  873.   <dd>
    874. 

  874.     
    875. 

  875.     Validates data; raises <tt class="docutils literal"><span class="pre"><span class="Identifier">CgiError</span></span></tt> if this fails. This checks that each variable name of the CGI <tt class="docutils literal"><span class="pre"><span class="Identifier">data</span></span></tt> occurs in the <tt class="docutils literal"><span class="pre"><span class="Identifier">validKeys</span></span></tt> array.
    876. 

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

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

  878. 

  879.   </dd>
    880. 

  880. </div>
    881. 

  881. 

  882. </div>
    883. 

  883. <div id="writeContentType-procs-all">
    884. 

  884.   <div id="writeContentType">
    885. 

  885.   <dt><pre><span class="Keyword">proc</span> <a href="#writeContentType"><span class="Identifier">writeContentType</span></a><span class="Other">(</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="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</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>
    886. 

  886.   <dd>
    887. 

  887.     
    888. 

  888.     <p>Calls this before starting to send your HTML data to <tt class="docutils literal"><span class="pre"><span class="Identifier">stdout</span></span></tt>. This implements this part of the CGI protocol:</p>
    889. 

  889. <p><pre class="listing"><span class="Identifier">write</span><span class="Punctuation">(</span><span class="Identifier">stdout</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Content-type: text/html</span><span class="EscapeSequence">\n</span><span class="EscapeSequence">\n</span><span class="StringLit">&quot;</span><span class="Punctuation">)</span></pre></p>
    890. 

  890. 

  891.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L271" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    892. 

  892. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L271" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    893. 

  893. 

  894.   </dd>
    895. 

  895. </div>
    896. 

  896. 

  897. </div>
    898. 

  898. <div id="writeErrorMessage-procs-all">
    899. 

  899.   <div id="writeErrorMessage,string">
    900. 

  900.   <dt><pre><span class="Keyword">proc</span> <a href="#writeErrorMessage%2Cstring"><span class="Identifier">writeErrorMessage</span></a><span class="Other">(</span><span class="Identifier">data</span><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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</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">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    901. 

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

  902.   <dd>
    903. 

  903.     
    904. 

  904.     Tries to reset browser state and writes <tt class="docutils literal"><span class="pre"><span class="Identifier">data</span></span></tt> to stdout in &lt;plaintext&gt; tag.
    905. 

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

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

  907. 

  908.   </dd>
    909. 

  909. </div>
    910. 

  910. 

  911. </div>
    912. 

  912. <div id="xmlEncode-procs-all">
    913. 

  913.   <div id="xmlEncode,string">
    914. 

  914.   <dt><pre><span class="Keyword">proc</span> <a href="#xmlEncode%2Cstring"><span class="Identifier">xmlEncode</span></a><span class="Other">(</span><span class="Identifier">s</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="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>
    915. 

  915.   <dd>
    916. 

  916.     
    917. 

  917.     Encodes a value to be XML safe:<ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="StringLit">&quot;</span></span></tt> is replaced by <tt class="docutils literal"><span class="pre"><span class="Operator">&amp;</span><span class="Identifier">quot</span><span class="Punctuation">;</span></span></tt></li>
    918. 

  918. <li><tt class="docutils literal"><span class="pre"><span class="Operator">&lt;</span></span></tt> is replaced by <tt class="docutils literal"><span class="pre"><span class="Operator">&amp;</span><span class="Identifier">lt</span><span class="Punctuation">;</span></span></tt></li>
    919. 

  919. <li><tt class="docutils literal"><span class="pre"><span class="Operator">&gt;</span></span></tt> is replaced by <tt class="docutils literal"><span class="pre"><span class="Operator">&amp;</span><span class="Identifier">gt</span><span class="Punctuation">;</span></span></tt></li>
    920. 

  920. <li><tt class="docutils literal"><span class="pre"><span class="Operator">&amp;</span></span></tt> is replaced by <tt class="docutils literal"><span class="pre"><span class="Operator">&amp;</span><span class="Identifier">amp</span><span class="Punctuation">;</span></span></tt></li>
    921. 

  921. <li>every other character is carried over.</li>
    922. 

  922. </ul>
    923. 

  923. 

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

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

  926. 

  927.   </dd>
    928. 

  928. </div>
    929. 

  929. 

  930. </div>
    931. 

  931. 

  932.   </dl>
    933. 

  933. </div>
    934. 

  934. <div class="section" id="15">
    935. 

  935.   <h1><a class="toc-backref" href="#15">Iterators</a></h1>
    936. 

  936.   <dl class="item">
    937. 

  937.     <div id="decodeData-iterators-all">
    938. 

  938.   <div id="decodeData.i,set[RequestMethod]">
    939. 

  939.   <dt><pre><span class="Keyword">iterator</span> <a href="#decodeData.i%2Cset%5BRequestMethod%5D"><span class="Identifier">decodeData</span></a><span class="Other">(</span><span class="Identifier">allowedMethods</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="cgi.html#RequestMethod"><span class="Identifier">RequestMethod</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">methodNone</span><span class="Other">,</span>
    940. 

  940.     <span class="Identifier">methodPost</span><span class="Other">,</span> <span class="Identifier">methodGet</span><span class="Other">}</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">,</span> <span class="Identifier">value</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.
    941. 

  941.     <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">CgiError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    942. 

  942.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadEnvEffect</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>
    943. 

  943.   <dd>
    944. 

  944.     
    945. 

  945.     Reads and decodes CGI data and yields the (name, value) pairs the data consists of. If the client does not use a method listed in the <tt class="docutils literal"><span class="pre"><span class="Identifier">allowedMethods</span></span></tt> set, a <tt class="docutils literal"><span class="pre"><span class="Identifier">CgiError</span></span></tt> exception is raised.
    946. 

  946.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/cgi.nim#L95" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    947. 

  947. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/cgi.nim#L95" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    948. 

  948. 

  949.   </dd>
    950. 

  950. </div>
    951. 

  951. <div id="decodeData.i,string">
    952. 

  952.   <dt><pre><span class="Keyword">iterator</span> <a href="#decodeData.i%2Cstring"><span class="Identifier">decodeData</span></a><span class="Other">(</span><span class="Identifier">data</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="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">,</span> <span class="Identifier">value</span><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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    953. 

  953.     <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>
    954. 

  954.   <dd>
    955. 

  955.     
    956. 

  956.     Reads and decodes CGI data and yields the (name, value) pairs the data consists of.
    957. 

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

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

  959. 

  960.   </dd>
    961. 

  961. </div>
    962. 

  962. 

  963. </div>
    964. 

  964. 

  965.   </dl>
    966. 

  966. </div>
    967. 

  967. 

  968.   </div>
    969. 

  969. </div>
    970. 

  970. 

  971.       <div class="twelve-columns footer">
    972. 

  972.         <span class="nim-sprite"></span>
    973. 

  973.         <br>
    974. 

  974.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-03 14:56:59 UTC</small>
    975. 

  975.       </div>
    976. 

  976.     </div>
    977. 

  977.   </div>
    978. 

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

  979.     
    980. 

  980. </body>
    981. 

  981. </html>
    982. 

  982.