mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2025-12-28 17:04:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
de413ab6bb6323b9661578ef5ebdec35c28b389e
Nim/jsonutils.html
github-actions[bot] de413ab6bb Deploy to GitHub pages
2025-12-25 20:14:24 +00:00

458 lines
57 KiB
HTML
Raw Blame History

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>std/jsonutils</title>
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
<!-- Favicon -->
<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=="/>
<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=">
<!-- CSS -->
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
<!-- JS -->
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
</head>
<body>
<div class="document" id="documentId">
<div class="container">
<h1 class="title">std/jsonutils</h1>
<div class="row">
<div class="three columns">
<div class="theme-select-wrapper">
<label for="theme-select">Theme:&nbsp;</label>
<select id="theme-select" onchange="setTheme(this.value)">
<option value="auto">🌗 Match OS</option>
<option value="dark">🌑 Dark</option>
<option value="light">🌕 Light</option>
</select>
</div>
<div id="global-links">
<ul class="simple-boot">
<li><a href="manual.html">Manual</a></li>
<li><a href="lib.html">Standard library</a></li>
<li> <a id="indexLink" href="theindex.html">Index</a></li>
<li><a href="compiler/theindex.html">Compiler docs</a></li>
<li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
<li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="search" id="searchInput"
oninput="search()" />
</div>
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#EnumMode" title="EnumMode = enum
joptEnumOrd, joptEnumSymbol, joptEnumString">EnumMode</a></li>
<li><a class="reference" href="#Joptions" title="Joptions = object
allowExtraKeys*: bool ## If `true` Nim's object to which the JSON is parsed is not required to
## have a field for every JSON key.
allowMissingKeys*: bool ## If `true` Nim's object to which JSON is parsed is allowed to have
## fields without corresponding JSON keys.">Joptions</a></li>
<li><a class="reference" href="#JsonNodeMode" title="JsonNodeMode = enum
joptJsonNodeAsRef, ## returns the ref as is
joptJsonNodeAsCopy, ## returns a deep copy of the JsonNode
joptJsonNodeAsObject ## treats JsonNode as a regular ref object">JsonNodeMode</a></li>
<li><a class="reference" href="#ToJsonOptions" title="ToJsonOptions = object
enumMode*: EnumMode
jsonNodeMode*: JsonNodeMode">ToJsonOptions</a></li>
</ul>
</details>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">fromJson
<li><a class="reference" href="#fromJson%2CT%2CJsonNode" title="fromJson[T](a: var T; b: JsonNode; opt = Joptions())">fromJson[T](a: var T; b: JsonNode; opt = Joptions())</a></li>
</ul>
<ul class="simple nested-toc-section">fromJsonHook
<li><a class="reference" href="#fromJsonHook%2CStringTableRef%2CJsonNode" title="fromJsonHook(a: var StringTableRef; b: JsonNode)">fromJsonHook(a: var StringTableRef; b: JsonNode)</a></li>
<li><a class="reference" href="#fromJsonHook%2CSomeSet%5BA%5D%2CJsonNode" title="fromJsonHook[A](s: var SomeSet[A]; jsonNode: JsonNode; opt = Joptions())">fromJsonHook[A](s: var SomeSet[A]; jsonNode: JsonNode; opt = Joptions())</a></li>
<li><a class="reference" href="#fromJsonHook%2C%2CJsonNode" title="fromJsonHook[K: string | cstring; V](t: var (Table[K, V] | OrderedTable[K, V]);
jsonNode: JsonNode; opt = Joptions())">fromJsonHook[K: string | cstring; V](t: var (Table[K, V] | OrderedTable[K, V]);
jsonNode: JsonNode; opt = Joptions())</a></li>
<li><a class="reference" href="#fromJsonHook%2COption%5BT%5D%2CJsonNode" title="fromJsonHook[T](self: var Option[T]; jsonNode: JsonNode; opt = Joptions())">fromJsonHook[T](self: var Option[T]; jsonNode: JsonNode; opt = Joptions())</a></li>
</ul>
<ul class="simple nested-toc-section">initToJsonOptions
<li><a class="reference" href="#initToJsonOptions" title="initToJsonOptions(): ToJsonOptions">initToJsonOptions(): ToJsonOptions</a></li>
</ul>
<ul class="simple nested-toc-section">jsonTo
<li><a class="reference" href="#jsonTo%2CJsonNode%2Ctypedesc" title="jsonTo(b: JsonNode; T: typedesc; opt = Joptions()): T:type">jsonTo(b: JsonNode; T: typedesc; opt = Joptions()): T:type</a></li>
</ul>
<ul class="simple nested-toc-section">toJson
<li><a class="reference" href="#toJson%2CT" title="toJson[T](a: T; opt = initToJsonOptions()): JsonNode">toJson[T](a: T; opt = initToJsonOptions()): JsonNode</a></li>
</ul>
<ul class="simple nested-toc-section">toJsonHook
<li><a class="reference" href="#toJsonHook%2CStringTableRef" title="toJsonHook(a: StringTableRef): JsonNode">toJsonHook(a: StringTableRef): JsonNode</a></li>
<li><a class="reference" href="#toJsonHook%2CSomeSet%5BA%5D" title="toJsonHook[A](s: SomeSet[A]; opt = initToJsonOptions()): JsonNode">toJsonHook[A](s: SomeSet[A]; opt = initToJsonOptions()): JsonNode</a></li>
<li><a class="reference" href="#toJsonHook" title="toJsonHook[K: string | cstring; V](t: (Table[K, V] | OrderedTable[K, V]);
opt = initToJsonOptions()): JsonNode">toJsonHook[K: string | cstring; V](t: (Table[K, V] | OrderedTable[K, V]);
opt = initToJsonOptions()): JsonNode</a></li>
<li><a class="reference" href="#toJsonHook%2COption%5BT%5D" title="toJsonHook[T](self: Option[T]; opt = initToJsonOptions()): JsonNode">toJsonHook[T](self: Option[T]; opt = initToJsonOptions()): JsonNode</a></li>
</ul>
</ul>
</details>
</li>
</ul>
</div>
<div class="nine columns" id="content">
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<div id="tocRoot"></div>
<p class="module-desc">This module implements a hookable (de)serialization for arbitrary types using JSON. Design goal: avoid importing modules where a custom serialization is needed; see strtabs.fromJsonHook,toJsonHook for an example.
<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">jsonutils</span>
<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">json</span><span class="Punctuation">]</span>
<span class="Keyword">type</span> <span class="Identifier">Foo</span> <span class="Operator">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span>
<span class="Identifier">t</span><span class="Punctuation">:</span> <span class="Identifier">bool</span>
<span class="Identifier">z1</span><span class="Punctuation">:</span> <span class="Identifier">int8</span>
<span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">(</span><span class="FloatNumber">1.5'f32</span><span class="Punctuation">,</span> <span class="Punctuation">(</span><span class="Identifier">b</span><span class="Punctuation">:</span> <span class="StringLit">&quot;b2&quot;</span><span class="Punctuation">,</span> <span class="Identifier">a</span><span class="Punctuation">:</span> <span class="StringLit">&quot;a2&quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="CharLit">'x'</span><span class="Punctuation">,</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Identifier">Foo</span><span class="Punctuation">(</span><span class="Identifier">t</span><span class="Punctuation">:</span> <span class="Identifier">true</span><span class="Punctuation">,</span> <span class="Identifier">z1</span><span class="Punctuation">:</span> <span class="Operator">-</span><span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Keyword">nil</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Punctuation">[</span><span class="Punctuation">{</span><span class="StringLit">&quot;name&quot;</span><span class="Punctuation">:</span> <span class="StringLit">&quot;John&quot;</span><span class="Punctuation">}</span><span class="Operator">.</span><span class="Identifier">newStringTable</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
<span class="Keyword">let</span> <span class="Identifier">j</span> <span class="Operator">=</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">toJson</span>
<span class="Identifier">assert</span> <span class="Identifier">j</span><span class="Operator">.</span><span class="Identifier">jsonTo</span><span class="Punctuation">(</span><span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">toJson</span> <span class="Operator">==</span> <span class="Identifier">j</span>
<span class="Identifier">assert</span> <span class="Operator">$</span><span class="Punctuation">[</span><span class="Identifier">NaN</span><span class="Punctuation">,</span> <span class="Identifier">Inf</span><span class="Punctuation">,</span> <span class="Operator">-</span><span class="Identifier">Inf</span><span class="Punctuation">,</span> <span class="FloatNumber">0.0</span><span class="Punctuation">,</span> <span class="Operator">-</span><span class="FloatNumber">0.0</span><span class="Punctuation">,</span> <span class="FloatNumber">1.0</span><span class="Punctuation">,</span> <span class="FloatNumber">1e-2</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">toJson</span> <span class="Operator">==</span> <span class="LongStringLit">&quot;&quot;&quot;[&quot;nan&quot;,&quot;inf&quot;,&quot;-inf&quot;,0.0,-0.0,1.0,0.01]&quot;&quot;&quot;</span>
<span class="Identifier">assert</span> <span class="FloatNumber">0.0</span><span class="Operator">.</span><span class="Identifier">toJson</span><span class="Operator">.</span><span class="Identifier">kind</span> <span class="Operator">==</span> <span class="Identifier">JFloat</span>
<span class="Identifier">assert</span> <span class="Identifier">Inf</span><span class="Operator">.</span><span class="Identifier">toJson</span><span class="Operator">.</span><span class="Identifier">kind</span> <span class="Operator">==</span> <span class="Identifier">JString</span></pre></p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="json.html">json</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="tables.html">tables</a>, <a class="reference external" href="sets.html">sets</a>, <a class="reference external" href="strtabs.html">strtabs</a>, <a class="reference external" href="options.html">options</a>, <a class="reference external" href="macros.html">macros</a>, <a class="reference external" href="enumutils.html">enumutils</a>, <a class="reference external" href="typetraits.html">typetraits</a>, <a class="reference external" href="assertions.html">assertions</a>
</dl>
</div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="EnumMode">
<dt><pre><a href="jsonutils.html#EnumMode"><span class="Identifier">EnumMode</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">joptEnumOrd</span><span class="Other">,</span> <span class="Identifier">joptEnumSymbol</span><span class="Other">,</span> <span class="Identifier">joptEnumString</span></pre></dt>
<dd>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L53" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L53" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="Joptions">
<dt><pre><a href="jsonutils.html#Joptions"><span class="Identifier">Joptions</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">allowExtraKeys</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> <span class="Comment">## If `true` Nim's object to which the JSON is parsed is not required to</span>
<span class="Comment">## have a field for every JSON key.</span>
<span class="Identifier">allowMissingKeys</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> <span class="Comment">## If `true` Nim's object to which JSON is parsed is allowed to have</span>
<span class="Comment">## fields without corresponding JSON keys.</span></pre></dt>
<dd>
Options controlling the behavior of <tt class="docutils literal"><span class="pre"><span class="Identifier">fromJson</span></span></tt>.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L44" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L44" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="JsonNodeMode">
<dt><pre><a href="jsonutils.html#JsonNodeMode"><span class="Identifier">JsonNodeMode</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">joptJsonNodeAsRef</span><span class="Other">,</span> <span class="Comment">## returns the ref as is</span>
<span class="Identifier">joptJsonNodeAsCopy</span><span class="Other">,</span> <span class="Comment">## returns a deep copy of the JsonNode</span>
<span class="Identifier">joptJsonNodeAsObject</span> <span class="Comment">## treats JsonNode as a regular ref object</span></pre></dt>
<dd>
controls <tt class="docutils literal"><span class="pre"><span class="Identifier">toJson</span></span></tt> for JsonNode types
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L57" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L57" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="ToJsonOptions">
<dt><pre><a href="jsonutils.html#ToJsonOptions"><span class="Identifier">ToJsonOptions</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">enumMode</span><span class="Operator">*</span><span class="Other">:</span> <a href="jsonutils.html#EnumMode"><span class="Identifier">EnumMode</span></a>
<span class="Identifier">jsonNodeMode</span><span class="Operator">*</span><span class="Other">:</span> <a href="jsonutils.html#JsonNodeMode"><span class="Identifier">JsonNodeMode</span></a></pre></dt>
<dd>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L61" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L61" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</dl>
</div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="fromJson-procs-all">
<div id="fromJson,T,JsonNode">
<dt><pre><span class="Keyword">proc</span> <a href="#fromJson%2CT%2CJsonNode"><span class="Identifier">fromJson</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="json.html#JsonNode"><span class="Identifier">JsonNode</span></a><span class="Other">;</span> <span class="Identifier">opt</span> <span class="Other">=</span> <a href="jsonutils.html#Joptions"><span class="Identifier">Joptions</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span></pre></dt>
<dd>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L183" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L183" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="fromJsonHook-procs-all">
<div id="fromJsonHook,StringTableRef,JsonNode">
<dt><pre><span class="Keyword">proc</span> <a href="#fromJsonHook%2CStringTableRef%2CJsonNode"><span class="Identifier">fromJsonHook</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="strtabs.html#StringTableRef"><span class="Identifier">StringTableRef</span></a><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="json.html#JsonNode"><span class="Identifier">JsonNode</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">ValueError</span><span class="Other">,</span> <span class="Identifier">KeyError</span><span class="Other">,</span> <span class="Identifier">JsonKindError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
<p>Enables <tt class="docutils literal"><span class="pre"><span class="Identifier">fromJson</span></span></tt> for <tt class="docutils literal"><span class="pre"><span class="Identifier">StringTableRef</span></span></tt> type.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="#toJsonHook,StringTableRef">toJsonHook proc</a></li>
</ul>
<p><strong class="examples_text">Example:</strong></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">json</span><span class="Punctuation">]</span>
<span class="Keyword">var</span> <span class="Identifier">t</span> <span class="Operator">=</span> <span class="Identifier">newStringTable</span><span class="Punctuation">(</span><span class="Identifier">modeCaseSensitive</span><span class="Punctuation">)</span>
<span class="Keyword">let</span> <span class="Identifier">jsonStr</span> <span class="Operator">=</span> <span class="LongStringLit">&quot;&quot;&quot;{&quot;mode&quot;: 0, &quot;table&quot;: {&quot;name&quot;: &quot;John&quot;, &quot;surname&quot;: &quot;Doe&quot;}}&quot;&quot;&quot;</span>
<span class="Identifier">fromJsonHook</span><span class="Punctuation">(</span><span class="Identifier">t</span><span class="Punctuation">,</span> <span class="Identifier">parseJson</span><span class="Punctuation">(</span><span class="Identifier">jsonStr</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Identifier">t</span><span class="Punctuation">[</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="Identifier">newStringTable</span><span class="Punctuation">(</span><span class="StringLit">&quot;name&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;John&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;surname&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Doe&quot;</span><span class="Punctuation">,</span>
<span class="Identifier">modeCaseSensitive</span><span class="Punctuation">)</span><span class="Punctuation">[</span><span class="Punctuation">]</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L462" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L462" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="fromJsonHook,SomeSet[A],JsonNode">
<dt><pre><span class="Keyword">proc</span> <a href="#fromJsonHook%2CSomeSet%5BA%5D%2CJsonNode"><span class="Identifier">fromJsonHook</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#SomeSet"><span class="Identifier">SomeSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">jsonNode</span><span class="Other">:</span> <a href="json.html#JsonNode"><span class="Identifier">JsonNode</span></a><span class="Other">;</span> <span class="Identifier">opt</span> <span class="Other">=</span> <a href="jsonutils.html#Joptions"><span class="Identifier">Joptions</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span></pre></dt>
<dd>
<p>Enables <tt class="docutils literal"><span class="pre"><span class="Identifier">fromJson</span></span></tt> for <tt class="docutils literal"><span class="pre"><span class="Identifier">HashSet</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">OrderedSet</span></span></tt> types.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="#toJsonHook,SomeSet[A]">toJsonHook proc</a></li>
</ul>
<p><strong class="examples_text">Example:</strong></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">sets</span><span class="Punctuation">,</span> <span class="Identifier">json</span><span class="Punctuation">]</span>
<span class="Keyword">var</span> <span class="Identifier">foo</span><span class="Punctuation">:</span> <span class="Keyword">tuple</span><span class="Punctuation">[</span><span class="Identifier">hs</span><span class="Punctuation">:</span> <span class="Identifier">HashSet</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Identifier">os</span><span class="Punctuation">:</span> <span class="Identifier">OrderedSet</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">]</span>
<span class="Identifier">fromJson</span><span class="Punctuation">(</span><span class="Identifier">foo</span><span class="Punctuation">,</span> <span class="Identifier">parseJson</span><span class="Punctuation">(</span><span class="LongStringLit">&quot;&quot;&quot;
{&quot;hs&quot;: [&quot;hash&quot;, &quot;set&quot;], &quot;os&quot;: [&quot;ordered&quot;, &quot;set&quot;]}&quot;&quot;&quot;</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Identifier">foo</span><span class="Operator">.</span><span class="Identifier">hs</span> <span class="Operator">==</span> <span class="Punctuation">[</span><span class="StringLit">&quot;hash&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;set&quot;</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">toHashSet</span>
<span class="Identifier">assert</span> <span class="Identifier">foo</span><span class="Operator">.</span><span class="Identifier">os</span> <span class="Operator">==</span> <span class="Punctuation">[</span><span class="StringLit">&quot;ordered&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;set&quot;</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">toOrderedSet</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L393" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L393" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="fromJsonHook,,JsonNode">
<dt><pre><span class="Keyword">proc</span> <a href="#fromJsonHook%2C%2CJsonNode"><span class="Identifier">fromJsonHook</span></a><span class="Other">[</span><span class="Identifier">K</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Operator">|</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">V</span><span class="Other">]</span><span class="Other">(</span>
<span class="Identifier">t</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Other">(</span><a href="tables.html#Table"><span class="Identifier">Table</span></a><span class="Other">[</span><span class="Identifier">K</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">]</span> <span class="Operator">|</span> <a href="tables.html#OrderedTable"><span class="Identifier">OrderedTable</span></a><span class="Other">[</span><span class="Identifier">K</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">]</span><span class="Other">)</span><span class="Other">;</span> <span class="Identifier">jsonNode</span><span class="Other">:</span> <a href="json.html#JsonNode"><span class="Identifier">JsonNode</span></a><span class="Other">;</span>
<span class="Identifier">opt</span> <span class="Other">=</span> <a href="jsonutils.html#Joptions"><span class="Identifier">Joptions</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span></pre></dt>
<dd>
<p>Enables <tt class="docutils literal"><span class="pre"><span class="Identifier">fromJson</span></span></tt> for <tt class="docutils literal"><span class="pre"><span class="Identifier">Table</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">OrderedTable</span></span></tt> types.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="#toJsonHook">toJsonHook proc</a></li>
</ul>
<p><strong class="examples_text">Example:</strong></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">tables</span><span class="Punctuation">,</span> <span class="Identifier">json</span><span class="Punctuation">]</span>
<span class="Keyword">var</span> <span class="Identifier">foo</span><span class="Punctuation">:</span> <span class="Keyword">tuple</span><span class="Punctuation">[</span><span class="Identifier">t</span><span class="Punctuation">:</span> <span class="Identifier">Table</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Identifier">ot</span><span class="Punctuation">:</span> <span class="Identifier">OrderedTable</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">]</span>
<span class="Identifier">fromJson</span><span class="Punctuation">(</span><span class="Identifier">foo</span><span class="Punctuation">,</span> <span class="Identifier">parseJson</span><span class="Punctuation">(</span><span class="LongStringLit">&quot;&quot;&quot;
{&quot;t&quot;:{&quot;two&quot;:2,&quot;one&quot;:1},&quot;ot&quot;:{&quot;one&quot;:1,&quot;three&quot;:3}}&quot;&quot;&quot;</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Identifier">foo</span><span class="Operator">.</span><span class="Identifier">t</span> <span class="Operator">==</span> <span class="Punctuation">[</span><span class="Punctuation">(</span><span class="StringLit">&quot;one&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Punctuation">(</span><span class="StringLit">&quot;two&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">toTable</span>
<span class="Identifier">assert</span> <span class="Identifier">foo</span><span class="Operator">.</span><span class="Identifier">ot</span> <span class="Operator">==</span> <span class="Punctuation">[</span><span class="Punctuation">(</span><span class="StringLit">&quot;one&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Punctuation">(</span><span class="StringLit">&quot;three&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">toOrderedTable</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L351" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L351" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="fromJsonHook,Option[T],JsonNode">
<dt><pre><span class="Keyword">proc</span> <a href="#fromJsonHook%2COption%5BT%5D%2CJsonNode"><span class="Identifier">fromJsonHook</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="options.html#Option"><span class="Identifier">Option</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">jsonNode</span><span class="Other">:</span> <a href="json.html#JsonNode"><span class="Identifier">JsonNode</span></a><span class="Other">;</span> <span class="Identifier">opt</span> <span class="Other">=</span> <a href="jsonutils.html#Joptions"><span class="Identifier">Joptions</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span></pre></dt>
<dd>
<p>Enables <tt class="docutils literal"><span class="pre"><span class="Identifier">fromJson</span></span></tt> for <tt class="docutils literal"><span class="pre"><span class="Identifier">Option</span></span></tt> types.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="#toJsonHook,Option[T]">toJsonHook proc</a></li>
</ul>
<p><strong class="examples_text">Example:</strong></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">options</span><span class="Punctuation">,</span> <span class="Identifier">json</span><span class="Punctuation">]</span>
<span class="Keyword">var</span> <span class="Identifier">opt</span><span class="Punctuation">:</span> <span class="Identifier">Option</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span>
<span class="Identifier">fromJsonHook</span><span class="Punctuation">(</span><span class="Identifier">opt</span><span class="Punctuation">,</span> <span class="Identifier">parseJson</span><span class="Punctuation">(</span><span class="StringLit">&quot;</span><span class="EscapeSequence">\&quot;</span><span class="StringLit">test</span><span class="EscapeSequence">\&quot;</span><span class="StringLit">&quot;</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Identifier">get</span><span class="Punctuation">(</span><span class="Identifier">opt</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;test&quot;</span>
<span class="Identifier">fromJson</span><span class="Punctuation">(</span><span class="Identifier">opt</span><span class="Punctuation">,</span> <span class="Identifier">parseJson</span><span class="Punctuation">(</span><span class="StringLit">&quot;null&quot;</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Identifier">isNone</span><span class="Punctuation">(</span><span class="Identifier">opt</span><span class="Punctuation">)</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L427" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L427" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="initToJsonOptions-procs-all">
<div id="initToJsonOptions">
<dt><pre><span class="Keyword">proc</span> <a href="#initToJsonOptions"><span class="Identifier">initToJsonOptions</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="jsonutils.html#ToJsonOptions"><span class="Identifier">ToJsonOptions</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>
<dd>
initializes <tt class="docutils literal"><span class="pre"><span class="Identifier">ToJsonOptions</span></span></tt> with sane options.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L66" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L66" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="jsonTo-procs-all">
<div id="jsonTo,JsonNode,typedesc">
<dt><pre><span class="Keyword">proc</span> <a href="#jsonTo%2CJsonNode%2Ctypedesc"><span class="Identifier">jsonTo</span></a><span class="Other">(</span><span class="Identifier">b</span><span class="Other">:</span> <a href="json.html#JsonNode"><span class="Identifier">JsonNode</span></a><span class="Other">;</span> <span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">;</span> <span class="Identifier">opt</span> <span class="Other">=</span> <a href="jsonutils.html#Joptions"><span class="Identifier">Joptions</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T:type</span></pre></dt>
<dd>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L208" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L208" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="toJson-procs-all">
<div id="toJson,T">
<dt><pre><span class="Keyword">proc</span> <a href="#toJson%2CT"><span class="Identifier">toJson</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">opt</span> <span class="Other">=</span> <span class="Identifier">initToJsonOptions</span><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="json.html#JsonNode"><span class="Identifier">JsonNode</span></a></pre></dt>
<dd>
serializes <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> to json; uses <tt class="docutils literal"><span class="pre"><span class="Identifier">toJsonHook</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">T</span><span class="Punctuation">)</span></span></tt> if it's in scope to customize serialization, see strtabs.toJsonHook for an example.<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
With <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">d</span><span class="Punctuation">:</span><span class="Identifier">nimPreviewJsonutilsHoleyEnum</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">toJson</span></span></tt> now can serialize/deserialize holey enums as regular enums (via <tt class="docutils literal"><span class="pre"><span class="Identifier">ord</span></span></tt>) instead of as strings. It is expected that this behavior becomes the new default in upcoming versions.</div>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L301" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L301" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="toJsonHook-procs-all">
<div id="toJsonHook,StringTableRef">
<dt><pre><span class="Keyword">proc</span> <a href="#toJsonHook%2CStringTableRef"><span class="Identifier">toJsonHook</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="strtabs.html#StringTableRef"><span class="Identifier">StringTableRef</span></a><span class="Other">)</span><span class="Other">:</span> <a href="json.html#JsonNode"><span class="Identifier">JsonNode</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>
<dd>
<p>Enables <tt class="docutils literal"><span class="pre"><span class="Identifier">toJson</span></span></tt> for <tt class="docutils literal"><span class="pre"><span class="Identifier">StringTableRef</span></span></tt> type.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="#fromJsonHook,StringTableRef,JsonNode">fromJsonHook proc</a></li>
</ul>
<p><strong class="examples_text">Example:</strong></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">json</span><span class="Punctuation">]</span>
<span class="Keyword">let</span> <span class="Identifier">t</span> <span class="Operator">=</span> <span class="Identifier">newStringTable</span><span class="Punctuation">(</span><span class="StringLit">&quot;name&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;John&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;surname&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Doe&quot;</span><span class="Punctuation">,</span> <span class="Identifier">modeCaseSensitive</span><span class="Punctuation">)</span>
<span class="Keyword">let</span> <span class="Identifier">jsonStr</span> <span class="Operator">=</span> <span class="LongStringLit">&quot;&quot;&quot;{&quot;mode&quot;: &quot;modeCaseSensitive&quot;,
&quot;table&quot;: {&quot;name&quot;: &quot;John&quot;, &quot;surname&quot;: &quot;Doe&quot;}}&quot;&quot;&quot;</span>
<span class="Identifier">assert</span> <span class="Identifier">toJson</span><span class="Punctuation">(</span><span class="Identifier">t</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">parseJson</span><span class="Punctuation">(</span><span class="Identifier">jsonStr</span><span class="Punctuation">)</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L480" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L480" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="toJsonHook,SomeSet[A]">
<dt><pre><span class="Keyword">proc</span> <a href="#toJsonHook%2CSomeSet%5BA%5D"><span class="Identifier">toJsonHook</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#SomeSet"><span class="Identifier">SomeSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">opt</span> <span class="Other">=</span> <span class="Identifier">initToJsonOptions</span><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="json.html#JsonNode"><span class="Identifier">JsonNode</span></a></pre></dt>
<dd>
<p>Enables <tt class="docutils literal"><span class="pre"><span class="Identifier">toJson</span></span></tt> for <tt class="docutils literal"><span class="pre"><span class="Identifier">HashSet</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">OrderedSet</span></span></tt> types.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="#fromJsonHook,SomeSet[A],JsonNode">fromJsonHook proc</a></li>
</ul>
<p><strong class="examples_text">Example:</strong></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">sets</span><span class="Punctuation">,</span> <span class="Identifier">json</span><span class="Punctuation">]</span>
<span class="Keyword">let</span> <span class="Identifier">foo</span> <span class="Operator">=</span> <span class="Punctuation">(</span><span class="Identifier">hs</span><span class="Punctuation">:</span> <span class="Punctuation">[</span><span class="StringLit">&quot;hash&quot;</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">toHashSet</span><span class="Punctuation">,</span> <span class="Identifier">os</span><span class="Punctuation">:</span> <span class="Punctuation">[</span><span class="StringLit">&quot;ordered&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;set&quot;</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">toOrderedSet</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">toJson</span><span class="Punctuation">(</span><span class="Identifier">foo</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="LongStringLit">&quot;&quot;&quot;{&quot;hs&quot;:[&quot;hash&quot;],&quot;os&quot;:[&quot;ordered&quot;,&quot;set&quot;]}&quot;&quot;&quot;</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L413" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L413" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="toJsonHook">
<dt><pre><span class="Keyword">proc</span> <a href="#toJsonHook"><span class="Identifier">toJsonHook</span></a><span class="Other">[</span><span class="Identifier">K</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Operator">|</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">V</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Other">(</span><a href="tables.html#Table"><span class="Identifier">Table</span></a><span class="Other">[</span><span class="Identifier">K</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">]</span> <span class="Operator">|</span> <a href="tables.html#OrderedTable"><span class="Identifier">OrderedTable</span></a><span class="Other">[</span><span class="Identifier">K</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">]</span><span class="Other">)</span><span class="Other">;</span>
<span class="Identifier">opt</span> <span class="Other">=</span> <span class="Identifier">initToJsonOptions</span><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="json.html#JsonNode"><span class="Identifier">JsonNode</span></a></pre></dt>
<dd>
<p>Enables <tt class="docutils literal"><span class="pre"><span class="Identifier">toJson</span></span></tt> for <tt class="docutils literal"><span class="pre"><span class="Identifier">Table</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">OrderedTable</span></span></tt> types.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="#fromJsonHook,,JsonNode">fromJsonHook proc</a></li>
</ul>
<p><strong class="examples_text">Example:</strong></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">tables</span><span class="Punctuation">,</span> <span class="Identifier">json</span><span class="Punctuation">,</span> <span class="Identifier">sugar</span><span class="Punctuation">]</span>
<span class="Keyword">let</span> <span class="Identifier">foo</span> <span class="Operator">=</span> <span class="Punctuation">(</span>
<span class="Identifier">t</span><span class="Punctuation">:</span> <span class="Punctuation">[</span><span class="Punctuation">(</span><span class="StringLit">&quot;two&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">toTable</span><span class="Punctuation">,</span>
<span class="Identifier">ot</span><span class="Punctuation">:</span> <span class="Punctuation">[</span><span class="Punctuation">(</span><span class="StringLit">&quot;one&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Punctuation">(</span><span class="StringLit">&quot;three&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">toOrderedTable</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">toJson</span><span class="Punctuation">(</span><span class="Identifier">foo</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="LongStringLit">&quot;&quot;&quot;{&quot;t&quot;:{&quot;two&quot;:2},&quot;ot&quot;:{&quot;one&quot;:1,&quot;three&quot;:3}}&quot;&quot;&quot;</span>
<span class="Comment"># if keys are not string|cstring, you can use this:</span>
<span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">10</span><span class="Punctuation">:</span> <span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">11</span><span class="Punctuation">:</span> <span class="StringLit">&quot;bar&quot;</span><span class="Punctuation">}</span><span class="Operator">.</span><span class="Identifier">newOrderedTable</span>
<span class="Keyword">let</span> <span class="Identifier">a2</span> <span class="Operator">=</span> <span class="Identifier">collect</span><span class="Punctuation">:</span> <span class="Punctuation">(</span><span class="Keyword">for</span> <span class="Identifier">k</span><span class="Punctuation">,</span><span class="Identifier">v</span> <span class="Keyword">in</span> <span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Punctuation">(</span><span class="Identifier">k</span><span class="Punctuation">,</span><span class="Identifier">v</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">toJson</span><span class="Punctuation">(</span><span class="Identifier">a2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="LongStringLit">&quot;&quot;&quot;[[10,&quot;foo&quot;],[11,&quot;bar&quot;]]&quot;&quot;&quot;</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L372" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L372" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="toJsonHook,Option[T]">
<dt><pre><span class="Keyword">proc</span> <a href="#toJsonHook%2COption%5BT%5D"><span class="Identifier">toJsonHook</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="options.html#Option"><span class="Identifier">Option</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">opt</span> <span class="Other">=</span> <span class="Identifier">initToJsonOptions</span><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="json.html#JsonNode"><span class="Identifier">JsonNode</span></a></pre></dt>
<dd>
<p>Enables <tt class="docutils literal"><span class="pre"><span class="Identifier">toJson</span></span></tt> for <tt class="docutils literal"><span class="pre"><span class="Identifier">Option</span></span></tt> types.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="#fromJsonHook,Option[T],JsonNode">fromJsonHook proc</a></li>
</ul>
<p><strong class="examples_text">Example:</strong></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">options</span><span class="Punctuation">,</span> <span class="Identifier">json</span><span class="Punctuation">]</span>
<span class="Keyword">let</span> <span class="Identifier">optSome</span> <span class="Operator">=</span> <span class="Identifier">some</span><span class="Punctuation">(</span><span class="StringLit">&quot;test&quot;</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">toJson</span><span class="Punctuation">(</span><span class="Identifier">optSome</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;</span><span class="EscapeSequence">\&quot;</span><span class="StringLit">test</span><span class="EscapeSequence">\&quot;</span><span class="StringLit">&quot;</span>
<span class="Keyword">let</span> <span class="Identifier">optNone</span> <span class="Operator">=</span> <span class="Identifier">none</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">toJson</span><span class="Punctuation">(</span><span class="Identifier">optNone</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;null&quot;</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsonutils.nim#L445" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsonutils.nim#L445" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
</dl>
</div>
</div>
</div>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br>
<small style="color: var(--hint);">Made with Nim. Generated: 2025-12-25 20:13:51 UTC</small>
</div>
</div>
</div>
<script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink