renderd7/structnlohmann_1_1json__sax.html
2022-04-13 18:07:13 +00:00

623 lines
29 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Renderd7-nightly: nlohmann::json_sax&lt; BasicJsonType &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="docsn.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Renderd7-nightly
&#160;<span id="projectnumber">v0.7.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structnlohmann_1_1json__sax.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structnlohmann_1_1json__sax-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">nlohmann::json_sax&lt; BasicJsonType &gt; Struct Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>SAX interface.
<a href="structnlohmann_1_1json__sax.html#details">More...</a></p>
<p><code>#include &lt;json.hpp&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0ad26edef3f8d530dcec3192bba82df6"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1json__sax.html#a0ad26edef3f8d530dcec3192bba82df6">null</a> ()=0</td></tr>
<tr class="memdesc:a0ad26edef3f8d530dcec3192bba82df6"><td class="mdescLeft">&#160;</td><td class="mdescRight">a null value was read <a href="structnlohmann_1_1json__sax.html#a0ad26edef3f8d530dcec3192bba82df6">More...</a><br /></td></tr>
<tr class="separator:a0ad26edef3f8d530dcec3192bba82df6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82ed080814fa656191a537284bb0c575"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1json__sax.html#a82ed080814fa656191a537284bb0c575">boolean</a> (bool val)=0</td></tr>
<tr class="memdesc:a82ed080814fa656191a537284bb0c575"><td class="mdescLeft">&#160;</td><td class="mdescRight">a boolean value was read <a href="structnlohmann_1_1json__sax.html#a82ed080814fa656191a537284bb0c575">More...</a><br /></td></tr>
<tr class="separator:a82ed080814fa656191a537284bb0c575"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affa7a78b8e9cc9cc3ac99927143142a5"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1json__sax.html#affa7a78b8e9cc9cc3ac99927143142a5">number_integer</a> (number_integer_t val)=0</td></tr>
<tr class="memdesc:affa7a78b8e9cc9cc3ac99927143142a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">an integer number was read <a href="structnlohmann_1_1json__sax.html#affa7a78b8e9cc9cc3ac99927143142a5">More...</a><br /></td></tr>
<tr class="separator:affa7a78b8e9cc9cc3ac99927143142a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9b253083e0509923ba195136f49face"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1json__sax.html#ad9b253083e0509923ba195136f49face">number_unsigned</a> (number_unsigned_t val)=0</td></tr>
<tr class="memdesc:ad9b253083e0509923ba195136f49face"><td class="mdescLeft">&#160;</td><td class="mdescRight">an unsigned integer number was read <a href="structnlohmann_1_1json__sax.html#ad9b253083e0509923ba195136f49face">More...</a><br /></td></tr>
<tr class="separator:ad9b253083e0509923ba195136f49face"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7c31614e8a82164d2d7f8dbf4671b25"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1json__sax.html#ae7c31614e8a82164d2d7f8dbf4671b25">number_float</a> (number_float_t val, const string_t &amp;s)=0</td></tr>
<tr class="memdesc:ae7c31614e8a82164d2d7f8dbf4671b25"><td class="mdescLeft">&#160;</td><td class="mdescRight">an floating-point number was read <a href="structnlohmann_1_1json__sax.html#ae7c31614e8a82164d2d7f8dbf4671b25">More...</a><br /></td></tr>
<tr class="separator:ae7c31614e8a82164d2d7f8dbf4671b25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07eab82f6c82d606787eee9ad73d2bda"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1json__sax.html#a07eab82f6c82d606787eee9ad73d2bda">string</a> (string_t &amp;val)=0</td></tr>
<tr class="memdesc:a07eab82f6c82d606787eee9ad73d2bda"><td class="mdescLeft">&#160;</td><td class="mdescRight">a string was read <a href="structnlohmann_1_1json__sax.html#a07eab82f6c82d606787eee9ad73d2bda">More...</a><br /></td></tr>
<tr class="separator:a07eab82f6c82d606787eee9ad73d2bda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38c2dbde07138cc436ea7fbf22c1e92d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1json__sax.html#a38c2dbde07138cc436ea7fbf22c1e92d">binary</a> (binary_t &amp;val)=0</td></tr>
<tr class="memdesc:a38c2dbde07138cc436ea7fbf22c1e92d"><td class="mdescLeft">&#160;</td><td class="mdescRight">a binary string was read <a href="structnlohmann_1_1json__sax.html#a38c2dbde07138cc436ea7fbf22c1e92d">More...</a><br /></td></tr>
<tr class="separator:a38c2dbde07138cc436ea7fbf22c1e92d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0671528b0debb5a348169d61f0382a0f"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1json__sax.html#a0671528b0debb5a348169d61f0382a0f">start_object</a> (std::size_t elements)=0</td></tr>
<tr class="memdesc:a0671528b0debb5a348169d61f0382a0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">the beginning of an object was read <a href="structnlohmann_1_1json__sax.html#a0671528b0debb5a348169d61f0382a0f">More...</a><br /></td></tr>
<tr class="separator:a0671528b0debb5a348169d61f0382a0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e0c7ecd80b18d18a8cc76f71cfc2028"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1json__sax.html#a2e0c7ecd80b18d18a8cc76f71cfc2028">key</a> (string_t &amp;val)=0</td></tr>
<tr class="memdesc:a2e0c7ecd80b18d18a8cc76f71cfc2028"><td class="mdescLeft">&#160;</td><td class="mdescRight">an object key was read <a href="structnlohmann_1_1json__sax.html#a2e0c7ecd80b18d18a8cc76f71cfc2028">More...</a><br /></td></tr>
<tr class="separator:a2e0c7ecd80b18d18a8cc76f71cfc2028"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0c722d53ff97be700ccf6a9468bd456"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1json__sax.html#ad0c722d53ff97be700ccf6a9468bd456">end_object</a> ()=0</td></tr>
<tr class="memdesc:ad0c722d53ff97be700ccf6a9468bd456"><td class="mdescLeft">&#160;</td><td class="mdescRight">the end of an object was read <a href="structnlohmann_1_1json__sax.html#ad0c722d53ff97be700ccf6a9468bd456">More...</a><br /></td></tr>
<tr class="separator:ad0c722d53ff97be700ccf6a9468bd456"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c53878cf08d463eb4e7ca0270532572"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1json__sax.html#a5c53878cf08d463eb4e7ca0270532572">start_array</a> (std::size_t elements)=0</td></tr>
<tr class="memdesc:a5c53878cf08d463eb4e7ca0270532572"><td class="mdescLeft">&#160;</td><td class="mdescRight">the beginning of an array was read <a href="structnlohmann_1_1json__sax.html#a5c53878cf08d463eb4e7ca0270532572">More...</a><br /></td></tr>
<tr class="separator:a5c53878cf08d463eb4e7ca0270532572"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a235ee975617f28e6a996d1e36a282312"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1json__sax.html#a235ee975617f28e6a996d1e36a282312">end_array</a> ()=0</td></tr>
<tr class="memdesc:a235ee975617f28e6a996d1e36a282312"><td class="mdescLeft">&#160;</td><td class="mdescRight">the end of an array was read <a href="structnlohmann_1_1json__sax.html#a235ee975617f28e6a996d1e36a282312">More...</a><br /></td></tr>
<tr class="separator:a235ee975617f28e6a996d1e36a282312"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60287e3bd85f489e04c83f7e3b76e613"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1json__sax.html#a60287e3bd85f489e04c83f7e3b76e613">parse_error</a> (std::size_t position, const std::string &amp;last_token, const <a class="el" href="classnlohmann_1_1detail_1_1exception.html">detail::exception</a> &amp;ex)=0</td></tr>
<tr class="memdesc:a60287e3bd85f489e04c83f7e3b76e613"><td class="mdescLeft">&#160;</td><td class="mdescRight">a parse error occurred <a href="structnlohmann_1_1json__sax.html#a60287e3bd85f489e04c83f7e3b76e613">More...</a><br /></td></tr>
<tr class="separator:a60287e3bd85f489e04c83f7e3b76e613"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename BasicJsonType&gt;<br />
struct nlohmann::json_sax&lt; BasicJsonType &gt;</h3>
<p>SAX interface. </p>
<p>This class describes the SAX interface used by <a class="el" href="classnlohmann_1_1basic__json.html#a21dc71dda1df5d840625c360329e69fe">nlohmann::json::sax_parse</a>. Each function is called in different situations while the input is parsed. The boolean return value informs the parser whether to continue processing the input. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a0ad26edef3f8d530dcec3192bba82df6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ad26edef3f8d530dcec3192bba82df6">&#9670;&nbsp;</a></span>null()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="structnlohmann_1_1json__sax.html">nlohmann::json_sax</a>&lt; BasicJsonType &gt;::null </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>a null value was read </p>
<dl class="section return"><dt>Returns</dt><dd>whether parsing should proceed </dd></dl>
</div>
</div>
<a id="a82ed080814fa656191a537284bb0c575"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82ed080814fa656191a537284bb0c575">&#9670;&nbsp;</a></span>boolean()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="structnlohmann_1_1json__sax.html">nlohmann::json_sax</a>&lt; BasicJsonType &gt;::boolean </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>val</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>a boolean value was read </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>boolean value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether parsing should proceed </dd></dl>
</div>
</div>
<a id="affa7a78b8e9cc9cc3ac99927143142a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affa7a78b8e9cc9cc3ac99927143142a5">&#9670;&nbsp;</a></span>number_integer()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="structnlohmann_1_1json__sax.html">nlohmann::json_sax</a>&lt; BasicJsonType &gt;::number_integer </td>
<td>(</td>
<td class="paramtype">number_integer_t&#160;</td>
<td class="paramname"><em>val</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>an integer number was read </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>integer value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether parsing should proceed </dd></dl>
</div>
</div>
<a id="ad9b253083e0509923ba195136f49face"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9b253083e0509923ba195136f49face">&#9670;&nbsp;</a></span>number_unsigned()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="structnlohmann_1_1json__sax.html">nlohmann::json_sax</a>&lt; BasicJsonType &gt;::number_unsigned </td>
<td>(</td>
<td class="paramtype">number_unsigned_t&#160;</td>
<td class="paramname"><em>val</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>an unsigned integer number was read </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>unsigned integer value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether parsing should proceed </dd></dl>
</div>
</div>
<a id="ae7c31614e8a82164d2d7f8dbf4671b25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7c31614e8a82164d2d7f8dbf4671b25">&#9670;&nbsp;</a></span>number_float()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="structnlohmann_1_1json__sax.html">nlohmann::json_sax</a>&lt; BasicJsonType &gt;::number_float </td>
<td>(</td>
<td class="paramtype">number_float_t&#160;</td>
<td class="paramname"><em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string_t &amp;&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>an floating-point number was read </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>floating-point value </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>raw token value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether parsing should proceed </dd></dl>
</div>
</div>
<a id="a07eab82f6c82d606787eee9ad73d2bda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07eab82f6c82d606787eee9ad73d2bda">&#9670;&nbsp;</a></span>string()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="structnlohmann_1_1json__sax.html">nlohmann::json_sax</a>&lt; BasicJsonType &gt;::string </td>
<td>(</td>
<td class="paramtype">string_t &amp;&#160;</td>
<td class="paramname"><em>val</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>a string was read </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>string value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether parsing should proceed </dd></dl>
<dl class="section note"><dt>Note</dt><dd>It is safe to move the passed string. </dd></dl>
</div>
</div>
<a id="a38c2dbde07138cc436ea7fbf22c1e92d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38c2dbde07138cc436ea7fbf22c1e92d">&#9670;&nbsp;</a></span>binary()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="structnlohmann_1_1json__sax.html">nlohmann::json_sax</a>&lt; BasicJsonType &gt;::binary </td>
<td>(</td>
<td class="paramtype">binary_t &amp;&#160;</td>
<td class="paramname"><em>val</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>a binary string was read </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>binary value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether parsing should proceed </dd></dl>
<dl class="section note"><dt>Note</dt><dd>It is safe to move the passed binary. </dd></dl>
</div>
</div>
<a id="a0671528b0debb5a348169d61f0382a0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0671528b0debb5a348169d61f0382a0f">&#9670;&nbsp;</a></span>start_object()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="structnlohmann_1_1json__sax.html">nlohmann::json_sax</a>&lt; BasicJsonType &gt;::start_object </td>
<td>(</td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>elements</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>the beginning of an object was read </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">elements</td><td>number of object elements or -1 if unknown </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether parsing should proceed </dd></dl>
<dl class="section note"><dt>Note</dt><dd>binary formats may report the number of elements </dd></dl>
</div>
</div>
<a id="a2e0c7ecd80b18d18a8cc76f71cfc2028"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e0c7ecd80b18d18a8cc76f71cfc2028">&#9670;&nbsp;</a></span>key()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="structnlohmann_1_1json__sax.html">nlohmann::json_sax</a>&lt; BasicJsonType &gt;::key </td>
<td>(</td>
<td class="paramtype">string_t &amp;&#160;</td>
<td class="paramname"><em>val</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>an object key was read </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>object key </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether parsing should proceed </dd></dl>
<dl class="section note"><dt>Note</dt><dd>It is safe to move the passed string. </dd></dl>
</div>
</div>
<a id="ad0c722d53ff97be700ccf6a9468bd456"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0c722d53ff97be700ccf6a9468bd456">&#9670;&nbsp;</a></span>end_object()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="structnlohmann_1_1json__sax.html">nlohmann::json_sax</a>&lt; BasicJsonType &gt;::end_object </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>the end of an object was read </p>
<dl class="section return"><dt>Returns</dt><dd>whether parsing should proceed </dd></dl>
</div>
</div>
<a id="a5c53878cf08d463eb4e7ca0270532572"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c53878cf08d463eb4e7ca0270532572">&#9670;&nbsp;</a></span>start_array()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="structnlohmann_1_1json__sax.html">nlohmann::json_sax</a>&lt; BasicJsonType &gt;::start_array </td>
<td>(</td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>elements</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>the beginning of an array was read </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">elements</td><td>number of array elements or -1 if unknown </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether parsing should proceed </dd></dl>
<dl class="section note"><dt>Note</dt><dd>binary formats may report the number of elements </dd></dl>
</div>
</div>
<a id="a235ee975617f28e6a996d1e36a282312"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a235ee975617f28e6a996d1e36a282312">&#9670;&nbsp;</a></span>end_array()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="structnlohmann_1_1json__sax.html">nlohmann::json_sax</a>&lt; BasicJsonType &gt;::end_array </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>the end of an array was read </p>
<dl class="section return"><dt>Returns</dt><dd>whether parsing should proceed </dd></dl>
</div>
</div>
<a id="a60287e3bd85f489e04c83f7e3b76e613"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60287e3bd85f489e04c83f7e3b76e613">&#9670;&nbsp;</a></span>parse_error()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BasicJsonType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="structnlohmann_1_1json__sax.html">nlohmann::json_sax</a>&lt; BasicJsonType &gt;::parse_error </td>
<td>(</td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>last_token</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classnlohmann_1_1detail_1_1exception.html">detail::exception</a> &amp;&#160;</td>
<td class="paramname"><em>ex</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>a parse error occurred </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">position</td><td>the position in the input where the error occurs </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">last_token</td><td>the last read token </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ex</td><td>an exception object describing the error </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether parsing should proceed (must return false) </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacenlohmann.html">nlohmann</a></li><li class="navelem"><a class="el" href="structnlohmann_1_1json__sax.html">json_sax</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>