json/api/basic_json/parse/index.html

334 lines
106 KiB
HTML
Raw Normal View History

<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=author content="Niels Lohmann"><link href=https://json.nlohmann.me/api/basic_json/parse/ rel=canonical><link rel=icon href=../../../assets/images/favicon.png><meta name=generator content="mkdocs-1.4.2, mkdocs-material-8.5.10"><title>parse - JSON for Modern C++</title><link rel=stylesheet href=../../../assets/stylesheets/main.975780f9.min.css><link rel=stylesheet href=../../../assets/stylesheets/palette.2505c338.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"JetBrains Mono"}</style><link rel=stylesheet href=../../../css/custom.css><script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script></head> <body dir=ltr data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo> <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#nlohmannbasic_jsonparse class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class=md-header data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../../.. title="JSON for Modern C++" class="md-header__button md-logo" aria-label="JSON for Modern C++" data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> JSON for Modern C++ </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> parse </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_2 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_2> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0
<span class=k>template</span><span class=o>&lt;</span><span class=k>typename</span><span class=w> </span><span class=nc>InputType</span><span class=o>&gt;</span><span class=w></span>
<span class=k>static</span><span class=w> </span><span class=n>basic_json</span><span class=w> </span><span class=n>parse</span><span class=p>(</span><span class=n>InputType</span><span class=o>&amp;&amp;</span><span class=w> </span><span class=n>i</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=k>const</span><span class=w> </span><span class=n>parser_callback_t</span><span class=w> </span><span class=n>cb</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>nullptr</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=k>const</span><span class=w> </span><span class=kt>bool</span><span class=w> </span><span class=n>allow_exceptions</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=nb>true</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=k>const</span><span class=w> </span><span class=kt>bool</span><span class=w> </span><span class=n>ignore_comments</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=nb>false</span><span class=p>);</span><span class=w></span>
<span class=c1>// (2)</span>
<span class=k>template</span><span class=o>&lt;</span><span class=k>typename</span><span class=w> </span><span class=nc>IteratorType</span><span class=o>&gt;</span><span class=w></span>
<span class=k>static</span><span class=w> </span><span class=n>basic_json</span><span class=w> </span><span class=n>parse</span><span class=p>(</span><span class=n>IteratorType</span><span class=w> </span><span class=n>first</span><span class=p>,</span><span class=w> </span><span class=n>IteratorType</span><span class=w> </span><span class=n>last</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=k>const</span><span class=w> </span><span class=n>parser_callback_t</span><span class=w> </span><span class=n>cb</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>nullptr</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=k>const</span><span class=w> </span><span class=kt>bool</span><span class=w> </span><span class=n>allow_exceptions</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=nb>true</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=k>const</span><span class=w> </span><span class=kt>bool</span><span class=w> </span><span class=n>ignore_comments</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=nb>false</span><span class=p>);</span><span class=w></span>
</code></pre></div> <ol> <li>Deserialize from a compatible input.</li> <li> <p>Deserialize from a pair of character iterators</p> <p>The <code>value_type</code> of the iterator must be an integral type with size of 1, 2 or 4 bytes, which will be interpreted respectively as UTF-8, UTF-16 and UTF-32.</p> </li> </ol> <h2 id=template-parameters>Template parameters<a class=headerlink href=#template-parameters title="Permanent link">&para;</a></h2> <dl> <dt><code>InputType</code></dt> <dd> <p>A compatible input, for instance:</p> <ul> <li>an <code>std::istream</code> object</li> <li>a <code>FILE</code> pointer (must not be null)</li> <li>a C-style array of characters</li> <li>a pointer to a null-terminated string of single byte characters</li> <li>a <code>std::string</code></li> <li>an object <code>obj</code> for which <code>begin(obj)</code> and <code>end(obj)</code> produces a valid pair of iterators.</li> </ul> </dd> <dt><code>IteratorType</code></dt> <dd> <p>a compatible iterator type, for instance.</p> <ul> <li>a pair of <code>std::string::iterator</code> or <code>std::vector&lt;std::uint8_t&gt;::iterator</code></li> <li>a pair of pointers such as <code>ptr</code> and <code>ptr + len</code></li> </ul> </dd> </dl> <h2 id=parameters>Parameters<a class=headerlink href=#parameters title="Permanent link">&para;</a></h2> <dl> <dt><code>i</code> (in)</dt> <dd>Input to parse from.</dd> <dt><code>cb</code> (in)</dt> <dd>a parser callback function of type <a href=../parser_callback_t/ ><code>parser_callback_t</code></a> which is used to control the deserialization by filtering unwanted values (optional)</dd> <dt><code>allow_exceptions</code> (in)</dt> <dd>whether to throw exceptions in case of a parse error (optional, <code class=highlight><span class=nb>true</span><span class=w></span></code> by default)</dd> <dt><code>ignore_comments</code> (in)</dt> <dd>whether comments should be ignored and treated like whitespace (<code class=highlight><span class=nb>true</span><span class=w></span></code>) or yield a parse error (<code class=highlight><span class=nb>false</span><span class=w></span></code>); (optional, <code class=highlight><span class=nb>false</span><span class=w></span></code> by default)</dd> <dt><code>first</code> (in)</dt> <dd>iterator to start of character range</dd> <dt><code>last</code> (in)</dt> <dd>iterator to end of character range</dd> </dl> <h2 id=return-value>Return value<a class=headerlink href=#return-value title="Permanent link">&para;</a></h2> <p>Deserialized JSON value; in case of a parse error and <code>allow_exceptions</code> set to <code class=highlight><span class=nb>false</span><span class=w></span></code>, the return value will be <code>value_t::discarded</code>. The latter can be checked with <a href=../is_discarded/ ><code>is_discarded</code></a>.</p> <h2 id=exception-safety>Exception safety<a class=headerlink href=#exception-safety title="Permanent link">&para;</a></h2> <p>Strong guarantee: if an exception is thrown, there are no changes in the JSON value.</p> <h2 id=exceptions>Exceptions<a class=headerlink href=#exceptions title="Permanent link">&para;</a></h2> <ul> <li>Throws <a href=../../../home/exceptions/#jsonexceptionparse_error101><code>parse_error.101</code></a> in case of an unexpected token.</li> <li>Throws <a href=../../../home/exceptions/#jsonexceptionparse_error102><code>parse_error.102</code></a> if to_unicode fails or surrogate error.</li> <li>Throws <a href=../../../home/exceptions/#jsonexceptionparse_error103><code>parse_error.103</code></a> if to_unicode fails.</li> </ul> <h2 id=complexity>Complexity<a class=headerlink href=#complexity title="Permanent link">&para;</a></h2> <p>Linear in the length of the input. The parser is a predictive LL(1) parser. The complexity can be higher if the parser callback function <code>cb</code> or reading from (1) the input <code>i</code> or (2) the iterator range [<code>first</code>, <code>last</code>] has a super-linear complexity.</p> <h2 id=notes>Notes<a class=headerlink href=#notes title="Permanent link">&para;</a></h2> <p>(1) A UTF-8 byte o
<span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;iomanip&gt;</span><span class=cp></span>
<span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;nlohmann/json.hpp&gt;</span><span class=cp></span>
<span class=k>using</span><span class=w> </span><span class=n>json</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>nlohmann</span><span class=o>::</span><span class=n>json</span><span class=p>;</span><span class=w></span>
<span class=kt>int</span><span class=w> </span><span class=nf>main</span><span class=p>()</span><span class=w></span>
<span class=p>{</span><span class=w></span>
<span class=w> </span><span class=c1>// a JSON text</span>
<span class=w> </span><span class=kt>char</span><span class=w> </span><span class=n>text</span><span class=p>[]</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=sa>R</span><span class=s>&quot;</span><span class=dl>(</span><span class=s></span>
<span class=s> {</span>
<span class=s> &quot;Image&quot;: {</span>
<span class=s> &quot;Width&quot;: 800,</span>
<span class=s> &quot;Height&quot;: 600,</span>
<span class=s> &quot;Title&quot;: &quot;View from 15th Floor&quot;,</span>
<span class=s> &quot;Thumbnail&quot;: {</span>
<span class=s> &quot;Url&quot;: &quot;http://www.example.com/image/481989943&quot;,</span>
<span class=s> &quot;Height&quot;: 125,</span>
<span class=s> &quot;Width&quot;: 100</span>
<span class=s> },</span>
<span class=s> &quot;Animated&quot; : false,</span>
<span class=s> &quot;IDs&quot;: [116, 943, 234, 38793]</span>
<span class=s> }</span>
<span class=s> }</span>
<span class=s> </span><span class=dl>)</span><span class=s>&quot;</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=c1>// parse and serialize JSON</span>
<span class=w> </span><span class=n>json</span><span class=w> </span><span class=n>j_complete</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse</span><span class=p>(</span><span class=n>text</span><span class=p>);</span><span class=w></span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>cout</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>setw</span><span class=p>(</span><span class=mi>4</span><span class=p>)</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>j_complete</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=s>&quot;</span><span class=se>\n\n</span><span class=s>&quot;</span><span class=p>;</span><span class=w></span>
<span class=p>}</span><span class=w></span>
</code></pre></div> <p>Output:</p> <div class=highlight><pre><span></span><code><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Image&quot;</span><span class=p>:</span><span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Animated&quot;</span><span class=p>:</span><span class=w> </span><span class=kc>false</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Height&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>600</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;IDs&quot;</span><span class=p>:</span><span class=w> </span><span class=p>[</span><span class=w></span>
<span class=w> </span><span class=mi>116</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>943</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>234</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>38793</span><span class=w></span>
<span class=w> </span><span class=p>],</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Thumbnail&quot;</span><span class=p>:</span><span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Height&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>125</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Url&quot;</span><span class=p>:</span><span class=w> </span><span class=s2>&quot;http://www.example.com/image/481989943&quot;</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Width&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>100</span><span class=w></span>
<span class=w> </span><span class=p>},</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Title&quot;</span><span class=p>:</span><span class=w> </span><span class=s2>&quot;View from 15th Floor&quot;</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Width&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>800</span><span class=w></span>
<span class=w> </span><span class=p>}</span><span class=w></span>
<span class=p>}</span><span class=w></span>
</code></pre></div> </details> <details class=example> <summary>Parsing from a string</summary> <p>The example below demonstrates the <code>parse()</code> function with and without callback function.</p> <div class=highlight><pre><span></span><code><span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;iostream&gt;</span><span class=cp></span>
<span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;iomanip&gt;</span><span class=cp></span>
<span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;nlohmann/json.hpp&gt;</span><span class=cp></span>
<span class=k>using</span><span class=w> </span><span class=n>json</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>nlohmann</span><span class=o>::</span><span class=n>json</span><span class=p>;</span><span class=w></span>
<span class=kt>int</span><span class=w> </span><span class=nf>main</span><span class=p>()</span><span class=w></span>
<span class=p>{</span><span class=w></span>
<span class=w> </span><span class=c1>// a JSON text</span>
<span class=w> </span><span class=k>auto</span><span class=w> </span><span class=n>text</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=sa>R</span><span class=s>&quot;</span><span class=dl>(</span><span class=s></span>
<span class=s> {</span>
<span class=s> &quot;Image&quot;: {</span>
<span class=s> &quot;Width&quot;: 800,</span>
<span class=s> &quot;Height&quot;: 600,</span>
<span class=s> &quot;Title&quot;: &quot;View from 15th Floor&quot;,</span>
<span class=s> &quot;Thumbnail&quot;: {</span>
<span class=s> &quot;Url&quot;: &quot;http://www.example.com/image/481989943&quot;,</span>
<span class=s> &quot;Height&quot;: 125,</span>
<span class=s> &quot;Width&quot;: 100</span>
<span class=s> },</span>
<span class=s> &quot;Animated&quot; : false,</span>
<span class=s> &quot;IDs&quot;: [116, 943, 234, 38793]</span>
<span class=s> }</span>
<span class=s> }</span>
<span class=s> </span><span class=dl>)</span><span class=s>&quot;</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=c1>// parse and serialize JSON</span>
<span class=w> </span><span class=n>json</span><span class=w> </span><span class=n>j_complete</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse</span><span class=p>(</span><span class=n>text</span><span class=p>);</span><span class=w></span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>cout</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>setw</span><span class=p>(</span><span class=mi>4</span><span class=p>)</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>j_complete</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=s>&quot;</span><span class=se>\n\n</span><span class=s>&quot;</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=c1>// define parser callback</span>
<span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parser_callback_t</span><span class=w> </span><span class=n>cb</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[](</span><span class=kt>int</span><span class=w> </span><span class=n>depth</span><span class=p>,</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse_event_t</span><span class=w> </span><span class=n>event</span><span class=p>,</span><span class=w> </span><span class=n>json</span><span class=w> </span><span class=o>&amp;</span><span class=w> </span><span class=n>parsed</span><span class=p>)</span><span class=w></span>
<span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=c1>// skip object elements with key &quot;Thumbnail&quot;</span>
<span class=w> </span><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=n>event</span><span class=w> </span><span class=o>==</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse_event_t</span><span class=o>::</span><span class=n>key</span><span class=w> </span><span class=n>and</span><span class=w> </span><span class=n>parsed</span><span class=w> </span><span class=o>==</span><span class=w> </span><span class=n>json</span><span class=p>(</span><span class=s>&quot;Thumbnail&quot;</span><span class=p>))</span><span class=w></span>
<span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=k>return</span><span class=w> </span><span class=nb>false</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=p>}</span><span class=w></span>
<span class=w> </span><span class=k>else</span><span class=w></span>
<span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=k>return</span><span class=w> </span><span class=nb>true</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=p>}</span><span class=w></span>
<span class=w> </span><span class=p>};</span><span class=w></span>
<span class=w> </span><span class=c1>// parse (with callback) and serialize JSON</span>
<span class=w> </span><span class=n>json</span><span class=w> </span><span class=n>j_filtered</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse</span><span class=p>(</span><span class=n>text</span><span class=p>,</span><span class=w> </span><span class=n>cb</span><span class=p>);</span><span class=w></span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>cout</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>setw</span><span class=p>(</span><span class=mi>4</span><span class=p>)</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>j_filtered</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=sc>&#39;\n&#39;</span><span class=p>;</span><span class=w></span>
<span class=p>}</span><span class=w></span>
</code></pre></div> <p>Output:</p> <div class=highlight><pre><span></span><code><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Image&quot;</span><span class=p>:</span><span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Animated&quot;</span><span class=p>:</span><span class=w> </span><span class=kc>false</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Height&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>600</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;IDs&quot;</span><span class=p>:</span><span class=w> </span><span class=p>[</span><span class=w></span>
<span class=w> </span><span class=mi>116</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>943</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>234</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>38793</span><span class=w></span>
<span class=w> </span><span class=p>],</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Thumbnail&quot;</span><span class=p>:</span><span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Height&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>125</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Url&quot;</span><span class=p>:</span><span class=w> </span><span class=s2>&quot;http://www.example.com/image/481989943&quot;</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Width&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>100</span><span class=w></span>
<span class=w> </span><span class=p>},</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Title&quot;</span><span class=p>:</span><span class=w> </span><span class=s2>&quot;View from 15th Floor&quot;</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Width&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>800</span><span class=w></span>
<span class=w> </span><span class=p>}</span><span class=w></span>
<span class=p>}</span><span class=w></span>
<span class=p>{</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Image&quot;</span><span class=p>:</span><span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Animated&quot;</span><span class=p>:</span><span class=w> </span><span class=kc>false</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Height&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>600</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;IDs&quot;</span><span class=p>:</span><span class=w> </span><span class=p>[</span><span class=w></span>
<span class=w> </span><span class=mi>116</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>943</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>234</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>38793</span><span class=w></span>
<span class=w> </span><span class=p>],</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Title&quot;</span><span class=p>:</span><span class=w> </span><span class=s2>&quot;View from 15th Floor&quot;</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Width&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>800</span><span class=w></span>
<span class=w> </span><span class=p>}</span><span class=w></span>
<span class=p>}</span><span class=w></span>
</code></pre></div> </details> <details class=example> <summary>Parsing from an input stream</summary> <p>The example below demonstrates the <code>parse()</code> function with and without callback function.</p> <div class=highlight><pre><span></span><code><span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;iostream&gt;</span><span class=cp></span>
<span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;iomanip&gt;</span><span class=cp></span>
<span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;sstream&gt;</span><span class=cp></span>
<span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;nlohmann/json.hpp&gt;</span><span class=cp></span>
<span class=k>using</span><span class=w> </span><span class=n>json</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>nlohmann</span><span class=o>::</span><span class=n>json</span><span class=p>;</span><span class=w></span>
<span class=kt>int</span><span class=w> </span><span class=nf>main</span><span class=p>()</span><span class=w></span>
<span class=p>{</span><span class=w></span>
<span class=w> </span><span class=c1>// a JSON text</span>
<span class=w> </span><span class=k>auto</span><span class=w> </span><span class=n>text</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=sa>R</span><span class=s>&quot;</span><span class=dl>(</span><span class=s></span>
<span class=s> {</span>
<span class=s> &quot;Image&quot;: {</span>
<span class=s> &quot;Width&quot;: 800,</span>
<span class=s> &quot;Height&quot;: 600,</span>
<span class=s> &quot;Title&quot;: &quot;View from 15th Floor&quot;,</span>
<span class=s> &quot;Thumbnail&quot;: {</span>
<span class=s> &quot;Url&quot;: &quot;http://www.example.com/image/481989943&quot;,</span>
<span class=s> &quot;Height&quot;: 125,</span>
<span class=s> &quot;Width&quot;: 100</span>
<span class=s> },</span>
<span class=s> &quot;Animated&quot; : false,</span>
<span class=s> &quot;IDs&quot;: [116, 943, 234, 38793]</span>
<span class=s> }</span>
<span class=s> }</span>
<span class=s> </span><span class=dl>)</span><span class=s>&quot;</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=c1>// fill a stream with JSON text</span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>stringstream</span><span class=w> </span><span class=n>ss</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=n>ss</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>text</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=c1>// parse and serialize JSON</span>
<span class=w> </span><span class=n>json</span><span class=w> </span><span class=n>j_complete</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse</span><span class=p>(</span><span class=n>ss</span><span class=p>);</span><span class=w></span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>cout</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>setw</span><span class=p>(</span><span class=mi>4</span><span class=p>)</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>j_complete</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=s>&quot;</span><span class=se>\n\n</span><span class=s>&quot;</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=c1>// define parser callback</span>
<span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parser_callback_t</span><span class=w> </span><span class=n>cb</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[](</span><span class=kt>int</span><span class=w> </span><span class=n>depth</span><span class=p>,</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse_event_t</span><span class=w> </span><span class=n>event</span><span class=p>,</span><span class=w> </span><span class=n>json</span><span class=w> </span><span class=o>&amp;</span><span class=w> </span><span class=n>parsed</span><span class=p>)</span><span class=w></span>
<span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=c1>// skip object elements with key &quot;Thumbnail&quot;</span>
<span class=w> </span><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=n>event</span><span class=w> </span><span class=o>==</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse_event_t</span><span class=o>::</span><span class=n>key</span><span class=w> </span><span class=n>and</span><span class=w> </span><span class=n>parsed</span><span class=w> </span><span class=o>==</span><span class=w> </span><span class=n>json</span><span class=p>(</span><span class=s>&quot;Thumbnail&quot;</span><span class=p>))</span><span class=w></span>
<span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=k>return</span><span class=w> </span><span class=nb>false</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=p>}</span><span class=w></span>
<span class=w> </span><span class=k>else</span><span class=w></span>
<span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=k>return</span><span class=w> </span><span class=nb>true</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=p>}</span><span class=w></span>
<span class=w> </span><span class=p>};</span><span class=w></span>
<span class=w> </span><span class=c1>// fill a stream with JSON text</span>
<span class=w> </span><span class=n>ss</span><span class=p>.</span><span class=n>clear</span><span class=p>();</span><span class=w></span>
<span class=w> </span><span class=n>ss</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>text</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=c1>// parse (with callback) and serialize JSON</span>
<span class=w> </span><span class=n>json</span><span class=w> </span><span class=n>j_filtered</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse</span><span class=p>(</span><span class=n>ss</span><span class=p>,</span><span class=w> </span><span class=n>cb</span><span class=p>);</span><span class=w></span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>cout</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>setw</span><span class=p>(</span><span class=mi>4</span><span class=p>)</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>j_filtered</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=sc>&#39;\n&#39;</span><span class=p>;</span><span class=w></span>
<span class=p>}</span><span class=w></span>
</code></pre></div> <p>Output:</p> <div class=highlight><pre><span></span><code><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Image&quot;</span><span class=p>:</span><span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Animated&quot;</span><span class=p>:</span><span class=w> </span><span class=kc>false</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Height&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>600</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;IDs&quot;</span><span class=p>:</span><span class=w> </span><span class=p>[</span><span class=w></span>
<span class=w> </span><span class=mi>116</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>943</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>234</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>38793</span><span class=w></span>
<span class=w> </span><span class=p>],</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Thumbnail&quot;</span><span class=p>:</span><span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Height&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>125</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Url&quot;</span><span class=p>:</span><span class=w> </span><span class=s2>&quot;http://www.example.com/image/481989943&quot;</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Width&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>100</span><span class=w></span>
<span class=w> </span><span class=p>},</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Title&quot;</span><span class=p>:</span><span class=w> </span><span class=s2>&quot;View from 15th Floor&quot;</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Width&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>800</span><span class=w></span>
<span class=w> </span><span class=p>}</span><span class=w></span>
<span class=p>}</span><span class=w></span>
<span class=p>{</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Image&quot;</span><span class=p>:</span><span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Animated&quot;</span><span class=p>:</span><span class=w> </span><span class=kc>false</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Height&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>600</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;IDs&quot;</span><span class=p>:</span><span class=w> </span><span class=p>[</span><span class=w></span>
<span class=w> </span><span class=mi>116</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>943</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>234</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>38793</span><span class=w></span>
<span class=w> </span><span class=p>],</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Title&quot;</span><span class=p>:</span><span class=w> </span><span class=s2>&quot;View from 15th Floor&quot;</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=nt>&quot;Width&quot;</span><span class=p>:</span><span class=w> </span><span class=mi>800</span><span class=w></span>
<span class=w> </span><span class=p>}</span><span class=w></span>
<span class=p>}</span><span class=w></span>
</code></pre></div> </details> <details class=example> <summary>Parsing from a contiguous container</summary> <p>The example below demonstrates the <code>parse()</code> function reading from a contiguous container.</p> <div class=highlight><pre><span></span><code><span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;iostream&gt;</span><span class=cp></span>
<span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;iomanip&gt;</span><span class=cp></span>
<span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;nlohmann/json.hpp&gt;</span><span class=cp></span>
<span class=k>using</span><span class=w> </span><span class=n>json</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>nlohmann</span><span class=o>::</span><span class=n>json</span><span class=p>;</span><span class=w></span>
<span class=kt>int</span><span class=w> </span><span class=nf>main</span><span class=p>()</span><span class=w></span>
<span class=p>{</span><span class=w></span>
<span class=w> </span><span class=c1>// a JSON text given as std::vector</span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>vector</span><span class=o>&lt;</span><span class=n>std</span><span class=o>::</span><span class=kt>uint8_t</span><span class=o>&gt;</span><span class=w> </span><span class=n>text</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>{</span><span class=sc>&#39;[&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;1&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;,&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;2&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;,&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;3&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;]&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;\0&#39;</span><span class=p>};</span><span class=w></span>
<span class=w> </span><span class=c1>// parse and serialize JSON</span>
<span class=w> </span><span class=n>json</span><span class=w> </span><span class=n>j_complete</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse</span><span class=p>(</span><span class=n>text</span><span class=p>);</span><span class=w></span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>cout</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>setw</span><span class=p>(</span><span class=mi>4</span><span class=p>)</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>j_complete</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=s>&quot;</span><span class=se>\n\n</span><span class=s>&quot;</span><span class=p>;</span><span class=w></span>
<span class=p>}</span><span class=w></span>
</code></pre></div> <p>Output:</p> <div class=highlight><pre><span></span><code><span class=p>[</span><span class=w></span>
<span class=w> </span><span class=mi>1</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>2</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>3</span><span class=w></span>
<span class=p>]</span><span class=w></span>
</code></pre></div> </details> <details class=example> <summary>Parsing from a non null-terminated string</summary> <p>The example below demonstrates the <code>parse()</code> function reading from a string that is not null-terminated.</p> <div class=highlight><pre><span></span><code><span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;iostream&gt;</span><span class=cp></span>
<span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;iomanip&gt;</span><span class=cp></span>
<span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;nlohmann/json.hpp&gt;</span><span class=cp></span>
<span class=k>using</span><span class=w> </span><span class=n>json</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>nlohmann</span><span class=o>::</span><span class=n>json</span><span class=p>;</span><span class=w></span>
<span class=kt>int</span><span class=w> </span><span class=nf>main</span><span class=p>()</span><span class=w></span>
<span class=p>{</span><span class=w></span>
<span class=w> </span><span class=c1>// a JSON text given as string that is not null-terminated</span>
<span class=w> </span><span class=k>const</span><span class=w> </span><span class=kt>char</span><span class=o>*</span><span class=w> </span><span class=n>ptr</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s>&quot;[1,2,3]another value&quot;</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=c1>// parse and serialize JSON</span>
<span class=w> </span><span class=n>json</span><span class=w> </span><span class=n>j_complete</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse</span><span class=p>(</span><span class=n>ptr</span><span class=p>,</span><span class=w> </span><span class=n>ptr</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=mi>7</span><span class=p>);</span><span class=w></span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>cout</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>setw</span><span class=p>(</span><span class=mi>4</span><span class=p>)</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>j_complete</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=s>&quot;</span><span class=se>\n\n</span><span class=s>&quot;</span><span class=p>;</span><span class=w></span>
<span class=p>}</span><span class=w></span>
</code></pre></div> <p>Output:</p> <div class=highlight><pre><span></span><code><span class=p>[</span><span class=w></span>
<span class=w> </span><span class=mi>1</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>2</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>3</span><span class=w></span>
<span class=p>]</span><span class=w></span>
</code></pre></div> </details> <details class=example> <summary>Parsing from an iterator pair</summary> <p>The example below demonstrates the <code>parse()</code> function reading from an iterator pair.</p> <div class=highlight><pre><span></span><code><span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;iostream&gt;</span><span class=cp></span>
<span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;iomanip&gt;</span><span class=cp></span>
<span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;nlohmann/json.hpp&gt;</span><span class=cp></span>
<span class=k>using</span><span class=w> </span><span class=n>json</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>nlohmann</span><span class=o>::</span><span class=n>json</span><span class=p>;</span><span class=w></span>
<span class=kt>int</span><span class=w> </span><span class=nf>main</span><span class=p>()</span><span class=w></span>
<span class=p>{</span><span class=w></span>
<span class=w> </span><span class=c1>// a JSON text given an input with other values</span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>vector</span><span class=o>&lt;</span><span class=n>std</span><span class=o>::</span><span class=kt>uint8_t</span><span class=o>&gt;</span><span class=w> </span><span class=n>input</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>{</span><span class=sc>&#39;[&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;1&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;,&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;2&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;,&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;3&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;]&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;o&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;t&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;h&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;e&#39;</span><span class=p>,</span><span class=w> </span><span class=sc>&#39;r&#39;</span><span class=p>};</span><span class=w></span>
<span class=w> </span><span class=c1>// parse and serialize JSON</span>
<span class=w> </span><span class=n>json</span><span class=w> </span><span class=n>j_complete</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse</span><span class=p>(</span><span class=n>input</span><span class=p>.</span><span class=n>begin</span><span class=p>(),</span><span class=w> </span><span class=n>input</span><span class=p>.</span><span class=n>begin</span><span class=p>()</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=mi>7</span><span class=p>);</span><span class=w></span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>cout</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>setw</span><span class=p>(</span><span class=mi>4</span><span class=p>)</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>j_complete</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=s>&quot;</span><span class=se>\n\n</span><span class=s>&quot;</span><span class=p>;</span><span class=w></span>
<span class=p>}</span><span class=w></span>
</code></pre></div> <p>Output:</p> <div class=highlight><pre><span></span><code><span class=p>[</span><span class=w></span>
<span class=w> </span><span class=mi>1</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>2</span><span class=p>,</span><span class=w></span>
<span class=w> </span><span class=mi>3</span><span class=w></span>
<span class=p>]</span><span class=w></span>
</code></pre></div> </details> <details class=example> <summary>Effect of <code>allow_exceptions</code> parameter</summary> <p>The example below demonstrates the effect of the <code>allow_exceptions</code> parameter in the ´parse()` function.</p> <div class=highlight><pre><span></span><code><span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;iostream&gt;</span><span class=cp></span>
<span class=cp>#include</span><span class=w> </span><span class=cpf>&lt;nlohmann/json.hpp&gt;</span><span class=cp></span>
<span class=k>using</span><span class=w> </span><span class=n>json</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>nlohmann</span><span class=o>::</span><span class=n>json</span><span class=p>;</span><span class=w></span>
<span class=kt>int</span><span class=w> </span><span class=nf>main</span><span class=p>()</span><span class=w></span>
<span class=p>{</span><span class=w></span>
<span class=w> </span><span class=c1>// an invalid JSON text</span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>string</span><span class=w> </span><span class=n>text</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=sa>R</span><span class=s>&quot;</span><span class=dl>(</span><span class=s></span>
<span class=s> {</span>
<span class=s> &quot;key&quot;: &quot;value without closing quotes</span>
<span class=s> }</span>
<span class=s> </span><span class=dl>)</span><span class=s>&quot;</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=c1>// parse with exceptions</span>
<span class=w> </span><span class=k>try</span><span class=w></span>
<span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=n>json</span><span class=w> </span><span class=n>j</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse</span><span class=p>(</span><span class=n>text</span><span class=p>);</span><span class=w></span>
<span class=w> </span><span class=p>}</span><span class=w></span>
<span class=w> </span><span class=k>catch</span><span class=w> </span><span class=p>(</span><span class=k>const</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse_error</span><span class=o>&amp;</span><span class=w> </span><span class=n>e</span><span class=p>)</span><span class=w></span>
<span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>cout</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>e</span><span class=p>.</span><span class=n>what</span><span class=p>()</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>endl</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=p>}</span><span class=w></span>
<span class=w> </span><span class=c1>// parse without exceptions</span>
<span class=w> </span><span class=n>json</span><span class=w> </span><span class=n>j</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>json</span><span class=o>::</span><span class=n>parse</span><span class=p>(</span><span class=n>text</span><span class=p>,</span><span class=w> </span><span class=k>nullptr</span><span class=p>,</span><span class=w> </span><span class=nb>false</span><span class=p>);</span><span class=w></span>
<span class=w> </span><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=n>j</span><span class=p>.</span><span class=n>is_discarded</span><span class=p>())</span><span class=w></span>
<span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>cout</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=s>&quot;the input is invalid JSON&quot;</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>endl</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=p>}</span><span class=w></span>
<span class=w> </span><span class=k>else</span><span class=w></span>
<span class=w> </span><span class=p>{</span><span class=w></span>
<span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>cout</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=s>&quot;the input is valid JSON: &quot;</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>j</span><span class=w> </span><span class=o>&lt;&lt;</span><span class=w> </span><span class=n>std</span><span class=o>::</span><span class=n>endl</span><span class=p>;</span><span class=w></span>
<span class=w> </span><span class=p>}</span><span class=w></span>
<span class=p>}</span><span class=w></span>
</code></pre></div> <p>Output:</p> <div class=highlight><pre><span></span><code><span class=p>[</span><span class=err>jso</span><span class=kc>n</span><span class=err>.excep</span><span class=kc>t</span><span class=err>io</span><span class=kc>n</span><span class=err>.parse_error.</span><span class=mi>101</span><span class=p>]</span><span class=w> </span><span class=err>parse</span><span class=w> </span><span class=err>error</span><span class=w> </span><span class=err>a</span><span class=kc>t</span><span class=w> </span><span class=err>li</span><span class=kc>ne</span><span class=w> </span><span class=mi>4</span><span class=p>,</span><span class=w> </span><span class=err>colum</span><span class=kc>n</span><span class=w> </span><span class=mi>0</span><span class=p>:</span><span class=w> </span><span class=err>sy</span><span class=kc>nta</span><span class=err>x</span><span class=w> </span><span class=err>error</span><span class=w> </span><span class=err>while</span><span class=w> </span><span class=err>parsi</span><span class=kc>n</span><span class=err>g</span><span class=w> </span><span class=err>value</span><span class=w> </span><span class=mi>-</span><span class=w> </span><span class=err>i</span><span class=kc>n</span><span class=err>valid</span><span class=w> </span><span class=err>s</span><span class=kc>tr</span><span class=err>i</span><span class=kc>n</span><span class=err>g</span><span class=p>:</span><span class=w> </span><span class=err>co</span><span class=kc>ntr</span><span class=err>ol</span><span class=w> </span><span class=err>charac</span><span class=kc>ter</span><span class=w> </span><span class=err>U+</span><span class=mi>000</span><span class=err>A</span><span class=w> </span><span class=err>(LF)</span><span class=w> </span><span class=err>mus</span><span class=kc>t</span><span class=w> </span><span class=err>be</span><span class=w> </span><span class=err>escaped</span><span class=w> </span><span class=kc>t</span><span class=err>o</span><span class=w> </span><span class=err>\u</span><span class=mi>000</span><span class=err>A</span><span class=w> </span><span class=err>or</span><span class=w> </span><span class=err>\</span><span class=kc>n</span><span class=err>;</span><span class=w> </span><span class=err>las</span><span class=kc>t</span><span class=w> </span><span class=err>read</span><span class=p>:</span><span class=w> </span><span class=err>&#39;&quot;value without closing quotes&lt;U+000A&gt;&#39;</span>
<span class=err>the input is invalid JSON</span>
</code></pre></div> </details> <h2 id=see-also>See also<a class=headerlink href=#see-also title="Permanent link">&para;</a></h2> <ul> <li><a href=../accept/ >accept</a> - check if the input is valid JSON</li> <li><a href=../../operator_gtgt/ >operator&gt;&gt;</a> - deserialize from stream</li> </ul> <h2 id=version-history>Version history<a class=headerlink href=#version-history title="Permanent link">&para;</a></h2> <ul> <li>Added in version 1.0.0.</li> <li>Overload for contiguous containers (1) added in version 2.0.3.</li> <li>Ignoring comments via <code>ignore_comments</code> added in version 3.9.0.</li> </ul> <div class="admonition warning"> <p class=admonition-title>Deprecation</p> <p>Overload (2) replaces calls to <code>parse</code> with a pair of iterators as their first parameter which has been deprecated in version 3.8.0. This overload will be removed in version 4.0.0. Please replace all calls like <code class=highlight><span class=n>parse</span><span class=p>({</span><span class=n>ptr</span><span class=p>,</span><span class=w> </span><span class=n>ptr</span><span class=o>+</span><span class=n>len</span><span class=p>},</span><span class=w> </span><span class=p>...);</span><span class=w></span></code> with <code class=highlight><span class=n>parse</span><span class=p>(</span><span class=n>ptr</span><span class=p>,</span><span class=w> </span><span class=n>ptr</span><span class=o>+</span><span class=n>len</span><span class=p>,</span><span class=w> </span><span class=p>...);</span><span class=w></span></code>.</p> <p>You should be warned by your compiler with a <code>-Wdeprecated-declarations</code> warning if you are using a deprecated function.</p> </div> <hr> <div class=md-source-file> <small> Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 28, 2022</span> </small> </div> </article> </div> <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> </div> <a href=# class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </a> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../other_error/ class="md-footer__link md-footer__link--prev" aria-label="Previous: other_error" rel=prev> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </div> <div class=md-footer__title> <div class=md-ellipsis> <span class=md-footer__direction> Previous </span> other_error </div> </div> </a> <a href=../parse_error/ class="md-footer__link md-footer__link--next" aria-label="Next: parse_error" rel=next> <div class=md-footer__title> <div class=md-ellipsis> <span class=md-footer__direction> Next </span> parse_error </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright &copy; 2013 - 2022 Niels Lohmann </div> </div> <div class=md-social> <a href=https://github.com/nlohmann target=_blank rel=noopener title=github.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 496 512"><!-- Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6