parsejson.html 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>std/parsejson</title>
  9. <!-- Google fonts -->
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  11. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  12. <!-- Favicon -->
  13. <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=="/>
  14. <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=">
  15. <!-- CSS -->
  16. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
  17. <!-- JS -->
  18. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
  19. </head>
  20. <body>
  21. <div class="document" id="documentId">
  22. <div class="container">
  23. <h1 class="title">std/parsejson</h1>
  24. <div class="row">
  25. <div class="three columns">
  26. <div class="theme-select-wrapper">
  27. <label for="theme-select">Theme:&nbsp;</label>
  28. <select id="theme-select" onchange="setTheme(this.value)">
  29. <option value="auto">🌗 Match OS</option>
  30. <option value="dark">🌑 Dark</option>
  31. <option value="light">🌕 Light</option>
  32. </select>
  33. </div>
  34. <div id="global-links">
  35. <ul class="simple-boot">
  36. <li><a href="manual.html">Manual</a></li>
  37. <li><a href="lib.html">Standard library</a></li>
  38. <li> <a id="indexLink" href="theindex.html">Index</a></li>
  39. <li><a href="compiler/theindex.html">Compiler docs</a></li>
  40. <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
  41. <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
  42. </ul>
  43. </div>
  44. <div id="searchInputDiv">
  45. Search: <input type="search" id="searchInput"
  46. oninput="search()" />
  47. </div>
  48. <ul class="simple simple-toc" id="toc-list">
  49. <li>
  50. <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
  51. </li>
  52. <li>
  53. <details open>
  54. <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
  55. <ul class="simple simple-toc-section">
  56. <li><a class="reference" href="#JsonError_2" title="JsonError = enum
  57. errNone, ## no error
  58. errInvalidToken, ## invalid token
  59. errStringExpected, ## string expected
  60. errColonExpected, ## `:` expected
  61. errCommaExpected, ## `,` expected
  62. errBracketRiExpected, ## `]` expected
  63. errCurlyRiExpected, ## `}` expected
  64. errQuoteExpected, ## `&quot;` or `'` expected
  65. errEOC_Expected, ## `*/` expected
  66. errEofExpected, ## EOF expected
  67. errExprExpected ## expr expected">JsonError</a></li>
  68. <li><a class="reference" href="#JsonEventKind" title="JsonEventKind = enum
  69. jsonError, ## an error occurred during parsing
  70. jsonEof, ## end of file reached
  71. jsonString, ## a string literal
  72. jsonInt, ## an integer literal
  73. jsonFloat, ## a float literal
  74. jsonTrue, ## the value `true`
  75. jsonFalse, ## the value `false`
  76. jsonNull, ## the value `null`
  77. jsonObjectStart, ## start of an object: the `{` token
  78. jsonObjectEnd, ## end of an object: the `}` token
  79. jsonArrayStart, ## start of an array: the `[` token
  80. jsonArrayEnd ## end of an array: the `]` token">JsonEventKind</a></li>
  81. <li><a class="reference" href="#JsonKindError" title="JsonKindError = object of ValueError">JsonKindError</a></li>
  82. <li><a class="reference" href="#JsonParser" title="JsonParser = object of BaseLexer
  83. a*: string
  84. tok*: TokKind">JsonParser</a></li>
  85. <li><a class="reference" href="#JsonParsingError" title="JsonParsingError = object of ValueError">JsonParsingError</a></li>
  86. <li><a class="reference" href="#TokKind" title="TokKind = enum
  87. tkError, tkEof, tkString, tkInt, tkFloat, tkTrue, tkFalse, tkNull, tkCurlyLe,
  88. tkCurlyRi, tkBracketLe, tkBracketRi, tkColon, tkComma">TokKind</a></li>
  89. </ul>
  90. </details>
  91. </li>
  92. <li>
  93. <details open>
  94. <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
  95. <ul class="simple simple-toc-section">
  96. <li><a class="reference" href="#errorMessages" title="errorMessages: array[JsonError, string] = [&quot;no error&quot;, &quot;invalid token&quot;,
  97. &quot;string expected&quot;, &quot;\':\' expected&quot;, &quot;\',\' expected&quot;, &quot;\']\' expected&quot;,
  98. &quot;\'}\' expected&quot;, &quot;\'\&quot;\' or \&quot;\'\&quot; expected&quot;, &quot;\'*/\' expected&quot;,
  99. &quot;EOF expected&quot;, &quot;expression expected&quot;]">errorMessages</a></li>
  100. </ul>
  101. </details>
  102. </li>
  103. <li>
  104. <details open>
  105. <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
  106. <ul class="simple simple-toc-section">
  107. <ul class="simple nested-toc-section">close
  108. <li><a class="reference" href="#close%2CJsonParser" title="close(my: var JsonParser)">close(my: var JsonParser)</a></li>
  109. </ul>
  110. <ul class="simple nested-toc-section">eat
  111. <li><a class="reference" href="#eat%2CJsonParser%2CTokKind" title="eat(p: var JsonParser; tok: TokKind)">eat(p: var JsonParser; tok: TokKind)</a></li>
  112. </ul>
  113. <ul class="simple nested-toc-section">errorMsg
  114. <li><a class="reference" href="#errorMsg%2CJsonParser" title="errorMsg(my: JsonParser): string">errorMsg(my: JsonParser): string</a></li>
  115. </ul>
  116. <ul class="simple nested-toc-section">errorMsgExpected
  117. <li><a class="reference" href="#errorMsgExpected%2CJsonParser%2Cstring" title="errorMsgExpected(my: JsonParser; e: string): string">errorMsgExpected(my: JsonParser; e: string): string</a></li>
  118. </ul>
  119. <ul class="simple nested-toc-section">getColumn
  120. <li><a class="reference" href="#getColumn%2CJsonParser" title="getColumn(my: JsonParser): int">getColumn(my: JsonParser): int</a></li>
  121. </ul>
  122. <ul class="simple nested-toc-section">getFilename
  123. <li><a class="reference" href="#getFilename%2CJsonParser" title="getFilename(my: JsonParser): string">getFilename(my: JsonParser): string</a></li>
  124. </ul>
  125. <ul class="simple nested-toc-section">getFloat
  126. <li><a class="reference" href="#getFloat%2CJsonParser" title="getFloat(my: JsonParser): float">getFloat(my: JsonParser): float</a></li>
  127. </ul>
  128. <ul class="simple nested-toc-section">getInt
  129. <li><a class="reference" href="#getInt%2CJsonParser" title="getInt(my: JsonParser): BiggestInt">getInt(my: JsonParser): BiggestInt</a></li>
  130. </ul>
  131. <ul class="simple nested-toc-section">getLine
  132. <li><a class="reference" href="#getLine%2CJsonParser" title="getLine(my: JsonParser): int">getLine(my: JsonParser): int</a></li>
  133. </ul>
  134. <ul class="simple nested-toc-section">getTok
  135. <li><a class="reference" href="#getTok%2CJsonParser" title="getTok(my: var JsonParser): TokKind">getTok(my: var JsonParser): TokKind</a></li>
  136. </ul>
  137. <ul class="simple nested-toc-section">kind
  138. <li><a class="reference" href="#kind%2CJsonParser" title="kind(my: JsonParser): JsonEventKind">kind(my: JsonParser): JsonEventKind</a></li>
  139. </ul>
  140. <ul class="simple nested-toc-section">next
  141. <li><a class="reference" href="#next%2CJsonParser" title="next(my: var JsonParser)">next(my: var JsonParser)</a></li>
  142. </ul>
  143. <ul class="simple nested-toc-section">open
  144. <li><a class="reference" href="#open%2CJsonParser%2CStream%2Cstring" title="open(my: var JsonParser; input: Stream; filename: string;
  145. rawStringLiterals = false)">open(my: var JsonParser; input: Stream; filename: string;
  146. rawStringLiterals = false)</a></li>
  147. </ul>
  148. <ul class="simple nested-toc-section">parseEscapedUTF16
  149. <li><a class="reference" href="#parseEscapedUTF16%2Ccstring%2Cint" title="parseEscapedUTF16(buf: cstring; pos: var int): int">parseEscapedUTF16(buf: cstring; pos: var int): int</a></li>
  150. </ul>
  151. <ul class="simple nested-toc-section">raiseParseErr
  152. <li><a class="reference" href="#raiseParseErr%2CJsonParser%2Cstring" title="raiseParseErr(p: JsonParser; msg: string)">raiseParseErr(p: JsonParser; msg: string)</a></li>
  153. </ul>
  154. <ul class="simple nested-toc-section">str
  155. <li><a class="reference" href="#str%2CJsonParser" title="str(my: JsonParser): string">str(my: JsonParser): string</a></li>
  156. </ul>
  157. </ul>
  158. </details>
  159. </li>
  160. </ul>
  161. </div>
  162. <div class="nine columns" id="content">
  163. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  164. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  165. <div id="tocRoot"></div>
  166. <p class="module-desc">This module implements a json parser. It is used and exported by the <tt class="docutils literal"><span class="pre"><span class="Identifier">json</span></span></tt> standard library module, but can also be used in its own right.</p>
  167. <div class="section" id="6">
  168. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  169. <dl class="item">
  170. <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="lexbase.html">lexbase</a>, <a class="reference external" href="streams.html">streams</a>, <a class="reference external" href="unicode.html">unicode</a>, <a class="reference external" href="decode_helpers.html">decode_helpers</a>, <a class="reference external" href="assertions.html">assertions</a>
  171. </dl>
  172. </div>
  173. <div class="section" id="7">
  174. <h1><a class="toc-backref" href="#7">Types</a></h1>
  175. <dl class="item">
  176. <div id="JsonError_2">
  177. <dt><pre><a href="parsejson.html#JsonError"><span class="Identifier">JsonError</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
  178. <span class="Identifier">errNone</span><span class="Other">,</span> <span class="Comment">## no error</span>
  179. <span class="Identifier">errInvalidToken</span><span class="Other">,</span> <span class="Comment">## invalid token</span>
  180. <span class="Identifier">errStringExpected</span><span class="Other">,</span> <span class="Comment">## string expected</span>
  181. <span class="Identifier">errColonExpected</span><span class="Other">,</span> <span class="Comment">## `:` expected</span>
  182. <span class="Identifier">errCommaExpected</span><span class="Other">,</span> <span class="Comment">## `,` expected</span>
  183. <span class="Identifier">errBracketRiExpected</span><span class="Other">,</span> <span class="Comment">## `]` expected</span>
  184. <span class="Identifier">errCurlyRiExpected</span><span class="Other">,</span> <span class="Comment">## `}` expected</span>
  185. <span class="Identifier">errQuoteExpected</span><span class="Other">,</span> <span class="Comment">## `&quot;` or `'` expected</span>
  186. <span class="Identifier">errEOC_Expected</span><span class="Other">,</span> <span class="Comment">## `*/` expected</span>
  187. <span class="Identifier">errEofExpected</span><span class="Other">,</span> <span class="Comment">## EOF expected</span>
  188. <span class="Identifier">errExprExpected</span> <span class="Comment">## expr expected</span></pre></dt>
  189. <dd>
  190. enumeration that lists all errors that can occur
  191. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L51" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  192. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L51" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  193. </dd>
  194. </div>
  195. <div id="JsonEventKind">
  196. <dt><pre><a href="parsejson.html#JsonEventKind"><span class="Identifier">JsonEventKind</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
  197. <span class="Identifier">jsonError</span><span class="Other">,</span> <span class="Comment">## an error occurred during parsing</span>
  198. <span class="Identifier">jsonEof</span><span class="Other">,</span> <span class="Comment">## end of file reached</span>
  199. <span class="Identifier">jsonString</span><span class="Other">,</span> <span class="Comment">## a string literal</span>
  200. <span class="Identifier">jsonInt</span><span class="Other">,</span> <span class="Comment">## an integer literal</span>
  201. <span class="Identifier">jsonFloat</span><span class="Other">,</span> <span class="Comment">## a float literal</span>
  202. <span class="Identifier">jsonTrue</span><span class="Other">,</span> <span class="Comment">## the value `true`</span>
  203. <span class="Identifier">jsonFalse</span><span class="Other">,</span> <span class="Comment">## the value `false`</span>
  204. <span class="Identifier">jsonNull</span><span class="Other">,</span> <span class="Comment">## the value `null`</span>
  205. <span class="Identifier">jsonObjectStart</span><span class="Other">,</span> <span class="Comment">## start of an object: the `{` token</span>
  206. <span class="Identifier">jsonObjectEnd</span><span class="Other">,</span> <span class="Comment">## end of an object: the `}` token</span>
  207. <span class="Identifier">jsonArrayStart</span><span class="Other">,</span> <span class="Comment">## start of an array: the `[` token</span>
  208. <span class="Identifier">jsonArrayEnd</span> <span class="Comment">## end of an array: the `]` token</span></pre></dt>
  209. <dd>
  210. enumeration of all events that may occur when parsing
  211. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L21" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  212. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L21" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  213. </dd>
  214. </div>
  215. <div id="JsonKindError">
  216. <dt><pre><a href="parsejson.html#JsonKindError"><span class="Identifier">JsonKindError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a></pre></dt>
  217. <dd>
  218. raised by the <tt class="docutils literal"><span class="pre"><span class="Identifier">to</span></span></tt> macro if the JSON kind is incorrect.
  219. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L77" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  220. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L77" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  221. </dd>
  222. </div>
  223. <div id="JsonParser">
  224. <dt><pre><a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="lexbase.html#BaseLexer"><span class="Identifier">BaseLexer</span></a>
  225. <span class="Identifier">a</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>
  226. <span class="Identifier">tok</span><span class="Operator">*</span><span class="Other">:</span> <a href="parsejson.html#TokKind"><span class="Identifier">TokKind</span></a></pre></dt>
  227. <dd>
  228. the parser object.
  229. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L68" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  230. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L68" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  231. </dd>
  232. </div>
  233. <div id="JsonParsingError">
  234. <dt><pre><a href="parsejson.html#JsonParsingError"><span class="Identifier">JsonParsingError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a></pre></dt>
  235. <dd>
  236. is raised for a JSON error
  237. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L79" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  238. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L79" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  239. </dd>
  240. </div>
  241. <div id="TokKind">
  242. <dt><pre><a href="parsejson.html#TokKind"><span class="Identifier">TokKind</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
  243. <span class="Identifier">tkError</span><span class="Other">,</span> <span class="Identifier">tkEof</span><span class="Other">,</span> <span class="Identifier">tkString</span><span class="Other">,</span> <span class="Identifier">tkInt</span><span class="Other">,</span> <span class="Identifier">tkFloat</span><span class="Other">,</span> <span class="Identifier">tkTrue</span><span class="Other">,</span> <span class="Identifier">tkFalse</span><span class="Other">,</span> <span class="Identifier">tkNull</span><span class="Other">,</span> <span class="Identifier">tkCurlyLe</span><span class="Other">,</span>
  244. <span class="Identifier">tkCurlyRi</span><span class="Other">,</span> <span class="Identifier">tkBracketLe</span><span class="Other">,</span> <span class="Identifier">tkBracketRi</span><span class="Other">,</span> <span class="Identifier">tkColon</span><span class="Other">,</span> <span class="Identifier">tkComma</span></pre></dt>
  245. <dd>
  246. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L35" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  247. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L35" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  248. </dd>
  249. </div>
  250. </dl>
  251. </div>
  252. <div class="section" id="10">
  253. <h1><a class="toc-backref" href="#10">Consts</a></h1>
  254. <dl class="item">
  255. <div id="errorMessages">
  256. <dt><pre><a href="parsejson.html#errorMessages"><span class="Identifier">errorMessages</span></a><span class="Other">:</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">JsonError</span><span class="Other">,</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Other">[</span><span class="StringLit">&quot;no error&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;invalid token&quot;</span><span class="Other">,</span>
  257. <span class="StringLit">&quot;string expected&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;\':\' expected&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;\',\' expected&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;\']\' expected&quot;</span><span class="Other">,</span>
  258. <span class="StringLit">&quot;\'}\' expected&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;\'\&quot;\' or \&quot;\'\&quot; expected&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;\'*/\' expected&quot;</span><span class="Other">,</span>
  259. <span class="StringLit">&quot;EOF expected&quot;</span><span class="Other">,</span> <span class="StringLit">&quot;expression expected&quot;</span><span class="Other">]</span></pre></dt>
  260. <dd>
  261. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L82" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  262. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L82" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  263. </dd>
  264. </div>
  265. </dl>
  266. </div>
  267. <div class="section" id="12">
  268. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  269. <dl class="item">
  270. <div id="close-procs-all">
  271. <div id="close,JsonParser">
  272. <dt><pre><span class="Keyword">proc</span> <a href="#close%2CJsonParser"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
  273. <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>
  274. <dd>
  275. closes the parser <tt class="docutils literal"><span class="pre"><span class="Identifier">my</span></span></tt> and its associated input stream.
  276. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L120" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  277. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L120" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  278. </dd>
  279. </div>
  280. </div>
  281. <div id="eat-procs-all">
  282. <div id="eat,JsonParser,TokKind">
  283. <dt><pre><span class="Keyword">proc</span> <a href="#eat%2CJsonParser%2CTokKind"><span class="Identifier">eat</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</span></a><span class="Other">;</span> <span class="Identifier">tok</span><span class="Other">:</span> <a href="parsejson.html#TokKind"><span class="Identifier">TokKind</span></a><span class="Other">)</span> {.
  284. <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">JsonParsingError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
  285. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  286. <dd>
  287. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L520" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  288. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L520" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  289. </dd>
  290. </div>
  291. </div>
  292. <div id="errorMsg-procs-all">
  293. <div id="errorMsg,JsonParser">
  294. <dt><pre><span class="Keyword">proc</span> <a href="#errorMsg%2CJsonParser"><span class="Identifier">errorMsg</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  295. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  296. <dd>
  297. returns a helpful error message for the event <tt class="docutils literal"><span class="pre"><span class="Identifier">jsonError</span></span></tt>
  298. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L156" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  299. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L156" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  300. </dd>
  301. </div>
  302. </div>
  303. <div id="errorMsgExpected-procs-all">
  304. <div id="errorMsgExpected,JsonParser,string">
  305. <dt><pre><span class="Keyword">proc</span> <a href="#errorMsgExpected%2CJsonParser%2Cstring"><span class="Identifier">errorMsgExpected</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</span></a><span class="Other">;</span> <span class="Identifier">e</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="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
  306. <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>
  307. <dd>
  308. returns an error message &quot;<tt class="docutils literal"><span class="pre"><span class="Identifier">e</span></span></tt> expected&quot; in the same format as the other error messages
  309. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L162" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  310. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L162" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  311. </dd>
  312. </div>
  313. </div>
  314. <div id="getColumn-procs-all">
  315. <div id="getColumn,JsonParser">
  316. <dt><pre><span class="Keyword">proc</span> <a href="#getColumn%2CJsonParser"><span class="Identifier">getColumn</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  317. <dd>
  318. get the current column the parser has arrived at.
  319. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L144" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  320. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L144" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  321. </dd>
  322. </div>
  323. </div>
  324. <div id="getFilename-procs-all">
  325. <div id="getFilename,JsonParser">
  326. <dt><pre><span class="Keyword">proc</span> <a href="#getFilename%2CJsonParser"><span class="Identifier">getFilename</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">inline</span><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>
  327. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  328. <dd>
  329. get the filename of the file that the parser processes.
  330. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L152" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  331. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L152" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  332. </dd>
  333. </div>
  334. </div>
  335. <div id="getFloat-procs-all">
  336. <div id="getFloat,JsonParser">
  337. <dt><pre><span class="Keyword">proc</span> <a href="#getFloat%2CJsonParser"><span class="Identifier">getFloat</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  338. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  339. <dd>
  340. returns the number for the event: <tt class="docutils literal"><span class="pre"><span class="Identifier">jsonFloat</span></span></tt>
  341. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L135" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  342. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L135" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  343. </dd>
  344. </div>
  345. </div>
  346. <div id="getInt-procs-all">
  347. <div id="getInt,JsonParser">
  348. <dt><pre><span class="Keyword">proc</span> <a href="#getInt%2CJsonParser"><span class="Identifier">getInt</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#BiggestInt"><span class="Identifier">BiggestInt</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
  349. <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>
  350. <dd>
  351. returns the number for the event: <tt class="docutils literal"><span class="pre"><span class="Identifier">jsonInt</span></span></tt>
  352. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L130" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  353. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L130" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  354. </dd>
  355. </div>
  356. </div>
  357. <div id="getLine-procs-all">
  358. <div id="getLine,JsonParser">
  359. <dt><pre><span class="Keyword">proc</span> <a href="#getLine%2CJsonParser"><span class="Identifier">getLine</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  360. <dd>
  361. get the current line the parser has arrived at.
  362. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L148" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  363. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L148" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  364. </dd>
  365. </div>
  366. </div>
  367. <div id="getTok-procs-all">
  368. <div id="getTok,JsonParser">
  369. <dt><pre><span class="Keyword">proc</span> <a href="#getTok%2CJsonParser"><span class="Identifier">getTok</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="parsejson.html#TokKind"><span class="Identifier">TokKind</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
  370. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  371. <dd>
  372. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L354" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  373. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L354" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  374. </dd>
  375. </div>
  376. </div>
  377. <div id="kind-procs-all">
  378. <div id="kind,JsonParser">
  379. <dt><pre><span class="Keyword">proc</span> <a href="#kind%2CJsonParser"><span class="Identifier">kind</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="parsejson.html#JsonEventKind"><span class="Identifier">JsonEventKind</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  380. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  381. <dd>
  382. returns the current event type for the JSON parser
  383. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L140" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  384. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L140" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  385. </dd>
  386. </div>
  387. </div>
  388. <div id="next-procs-all">
  389. <div id="next,JsonParser">
  390. <dt><pre><span class="Keyword">proc</span> <a href="#next%2CJsonParser"><span class="Identifier">next</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</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="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
  391. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  392. <dd>
  393. retrieves the first/next event. This controls the parser.
  394. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L399" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  395. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L399" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  396. </dd>
  397. </div>
  398. </div>
  399. <div id="open-procs-all">
  400. <div id="open,JsonParser,Stream,string">
  401. <dt><pre><span class="Keyword">proc</span> <a href="#open%2CJsonParser%2CStream%2Cstring"><span class="Identifier">open</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</span></a><span class="Other">;</span> <span class="Identifier">input</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
  402. <span class="Identifier">rawStringLiterals</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
  403. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  404. <dd>
  405. initializes the parser with an input stream. <tt class="docutils literal"><span class="pre"><span class="Identifier">Filename</span></span></tt> is only used for nice error messages. If <tt class="docutils literal"><span class="pre"><span class="Identifier">rawStringLiterals</span></span></tt> is true, string literals are kept with their surrounding quotes and escape sequences in them are left untouched too.
  406. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L107" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  407. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L107" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  408. </dd>
  409. </div>
  410. </div>
  411. <div id="parseEscapedUTF16-procs-all">
  412. <div id="parseEscapedUTF16,cstring,int">
  413. <dt><pre><span class="Keyword">proc</span> <a href="#parseEscapedUTF16%2Ccstring%2Cint"><span class="Identifier">parseEscapedUTF16</span></a><span class="Other">(</span><span class="Identifier">buf</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">pos</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</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>
  414. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  415. <dd>
  416. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L168" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  417. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L168" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  418. </dd>
  419. </div>
  420. </div>
  421. <div id="raiseParseErr-procs-all">
  422. <div id="raiseParseErr,JsonParser,string">
  423. <dt><pre><span class="Keyword">proc</span> <a href="#raiseParseErr%2CJsonParser%2Cstring"><span class="Identifier">raiseParseErr</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</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">noinline</span><span class="Other">,</span> <span class="Identifier">noreturn</span><span class="Other">,</span>
  424. <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">JsonParsingError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  425. <dd>
  426. raises an <tt class="docutils literal"><span class="pre"><span class="Identifier">EJsonParsingError</span></span></tt> exception.
  427. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L516" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  428. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L516" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  429. </dd>
  430. </div>
  431. </div>
  432. <div id="str-procs-all">
  433. <div id="str,JsonParser">
  434. <dt><pre><span class="Keyword">proc</span> <a href="#str%2CJsonParser"><span class="Identifier">str</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="parsejson.html#JsonParser"><span class="Identifier">JsonParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">inline</span><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>
  435. <dd>
  436. returns the character data for the events: <tt class="docutils literal"><span class="pre"><span class="Identifier">jsonInt</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">jsonFloat</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">jsonString</span></span></tt>
  437. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsejson.nim#L124" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  438. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsejson.nim#L124" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  439. </dd>
  440. </div>
  441. </div>
  442. </dl>
  443. </div>
  444. </div>
  445. </div>
  446. <div class="twelve-columns footer">
  447. <span class="nim-sprite"></span>
  448. <br>
  449. <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-03 14:57:10 UTC</small>
  450. </div>
  451. </div>
  452. </div>
  453. <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
  454. </body>
  455. </html>