Files
simdjson-simdjson/token__iterator_8h_source.html
T
2023-12-08 17:21:07 +00:00

191 lines
22 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>simdjson: include/simdjson/generic/ondemand/token_iterator.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.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="projectlogo"><img alt="Logo" src="logotiny.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">simdjson
&#160;<span id="projectnumber">3.6.3</span>
</div>
<div id="projectbrief">Ridiculously Fast JSON</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</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('token__iterator_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">token_iterator.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef SIMDJSON_GENERIC_ONDEMAND_TOKEN_ITERATOR_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#ifndef SIMDJSON_CONDITIONAL_INCLUDE</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#define SIMDJSON_GENERIC_ONDEMAND_TOKEN_ITERATOR_H</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;simdjson/generic/ondemand/base.h&quot;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &quot;simdjson/generic/implementation_simdjson_result_base.h&quot;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;simdjson/generic/ondemand/logger.h&quot;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// SIMDJSON_CONDITIONAL_INCLUDE</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacesimdjson.html">simdjson</a> {</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">namespace </span>SIMDJSON_IMPLEMENTATION {</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">namespace </span>ondemand {</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">class </span>token_iterator {</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; simdjson_inline token_iterator() noexcept = default;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; simdjson_inline token_iterator(token_iterator &amp;&amp;other) noexcept = default;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; simdjson_inline token_iterator &amp;operator=(token_iterator &amp;&amp;other) noexcept = default;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; simdjson_inline token_iterator(const token_iterator &amp;other) noexcept = default;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; simdjson_inline token_iterator &amp;operator=(const token_iterator &amp;other) noexcept = default;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; simdjson_inline const uint8_t *return_current_and_advance() noexcept;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; simdjson_inline uint32_t current_offset() const noexcept;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; simdjson_inline const uint8_t *peek(int32_t delta=0) const noexcept;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; simdjson_inline uint32_t peek_length(int32_t delta=0) const noexcept;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; simdjson_inline const uint8_t *peek(token_position position) const noexcept;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; simdjson_inline uint32_t peek_length(token_position position) const noexcept;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; simdjson_inline token_position position() const noexcept;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; simdjson_inline <span class="keywordtype">void</span> set_position(token_position target_position) noexcept;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="comment">// NOTE: we don&#39;t support a full C++ iterator interface, because we expect people to make</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="comment">// different calls to advance the iterator based on *their own* state.</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; simdjson_inline <span class="keywordtype">bool</span> operator==(const token_iterator &amp;other) const noexcept;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; simdjson_inline <span class="keywordtype">bool</span> operator!=(const token_iterator &amp;other) const noexcept;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; simdjson_inline <span class="keywordtype">bool</span> operator&gt;(const token_iterator &amp;other) const noexcept;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; simdjson_inline <span class="keywordtype">bool</span> operator&gt;=(const token_iterator &amp;other) const noexcept;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; simdjson_inline <span class="keywordtype">bool</span> operator&lt;(const token_iterator &amp;other) const noexcept;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; simdjson_inline <span class="keywordtype">bool</span> operator&lt;=(const token_iterator &amp;other) const noexcept;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;protected:</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; simdjson_inline token_iterator(const uint8_t *buf, token_position position) noexcept;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; simdjson_inline uint32_t peek_index(int32_t delta=0) const noexcept;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; simdjson_inline uint32_t peek_index(token_position position) const noexcept;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; </div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; const uint8_t *buf{};</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; token_position _position{};</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span>json_iterator;</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span>value_iterator;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="namespacesimdjson_1_1_s_i_m_d_j_s_o_n___i_m_p_l_e_m_e_n_t_a_t_i_o_n_1_1ondemand.html#ac915f0c06e5ab0363e09593bba651330aa8cfde6331bd59eb2ac96f8911c4b666">object</a>;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span>... Args&gt;</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keyword">friend</span> simdjson_inline <span class="keywordtype">void</span> logger::log_line(<span class="keyword">const</span> json_iterator &amp;iter, <span class="keyword">const</span> <span class="keywordtype">char</span> *title_prefix, <span class="keyword">const</span> <span class="keywordtype">char</span> *title, std::string_view detail, <span class="keywordtype">int</span> delta, <span class="keywordtype">int</span> depth_delta, logger::log_level level, Args&amp;&amp;... args) noexcept;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span>... Args&gt;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">friend</span> simdjson_inline <span class="keywordtype">void</span> logger::log_line(<span class="keyword">const</span> json_iterator &amp;iter, token_position index, <a class="code" href="namespacesimdjson_1_1_s_i_m_d_j_s_o_n___i_m_p_l_e_m_e_n_t_a_t_i_o_n_1_1ondemand.html#af941be7ff0cfaeb30d15d2fb52e76dd1">depth_t</a> depth, <span class="keyword">const</span> <span class="keywordtype">char</span> *title_prefix, <span class="keyword">const</span> <span class="keywordtype">char</span> *title, std::string_view detail, logger::log_level level, Args&amp;&amp;... args) noexcept;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;};</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; </div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;} <span class="comment">// namespace ondemand</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;} <span class="comment">// namespace SIMDJSON_IMPLEMENTATION</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;} <span class="comment">// namespace simdjson</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacesimdjson.html">simdjson</a> {</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="keyword">template</span>&lt;&gt;</div>
<div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="structsimdjson_1_1simdjson__result_3_01_s_i_m_d_j_s_o_n___i_m_p_l_e_m_e_n_t_a_t_i_o_n_1_1ondemand_1_1token__iterator_01_4.html"> 141</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>&lt;SIMDJSON_IMPLEMENTATION::ondemand::token_iterator&gt; : <span class="keyword">public</span> <a class="code" href="structsimdjson_1_1_s_i_m_d_j_s_o_n___i_m_p_l_e_m_e_n_t_a_t_i_o_n_1_1implementation__simdjson__result__base.html">SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base</a>&lt;SIMDJSON_IMPLEMENTATION::ondemand::token_iterator&gt; {</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; simdjson_inline <a class="code" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>(SIMDJSON_IMPLEMENTATION::ondemand::token_iterator &amp;&amp;<a class="code" href="structsimdjson_1_1simdjson__result.html#af7f6d5a5e979b60d5231449d53dcd9be">value</a>) noexcept; </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; simdjson_inline <a class="code" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>(<a class="code" href="namespacesimdjson.html#a7b735a3a50ba79e3f7f14df5f77d8da9">error_code</a> <a class="code" href="structsimdjson_1_1simdjson__result.html#a23470fcc7f01262019e96d3f3010b4a1">error</a>) noexcept; </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; simdjson_inline <a class="code" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>() noexcept = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; simdjson_inline ~<a class="code" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>() noexcept = <span class="keywordflow">default</span>; </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;};</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; </div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;} <span class="comment">// namespace simdjson</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// SIMDJSON_GENERIC_ONDEMAND_TOKEN_ITERATOR_H</span></div>
<div class="ttc" id="anamespacesimdjson_1_1_s_i_m_d_j_s_o_n___i_m_p_l_e_m_e_n_t_a_t_i_o_n_1_1ondemand_html_ac915f0c06e5ab0363e09593bba651330aa8cfde6331bd59eb2ac96f8911c4b666"><div class="ttname"><a href="namespacesimdjson_1_1_s_i_m_d_j_s_o_n___i_m_p_l_e_m_e_n_t_a_t_i_o_n_1_1ondemand.html#ac915f0c06e5ab0363e09593bba651330aa8cfde6331bd59eb2ac96f8911c4b666">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::json_type::object</a></div><div class="ttdeci">@ object</div><div class="ttdoc">A JSON object ( { &quot;a&quot;: 1, &quot;b&quot; 2, ... } )</div></div>
<div class="ttc" id="anamespacesimdjson_1_1_s_i_m_d_j_s_o_n___i_m_p_l_e_m_e_n_t_a_t_i_o_n_1_1ondemand_html_af941be7ff0cfaeb30d15d2fb52e76dd1"><div class="ttname"><a href="namespacesimdjson_1_1_s_i_m_d_j_s_o_n___i_m_p_l_e_m_e_n_t_a_t_i_o_n_1_1ondemand.html#af941be7ff0cfaeb30d15d2fb52e76dd1">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::depth_t</a></div><div class="ttdeci">int32_t depth_t</div><div class="ttdoc">Represents the depth of a JSON value (number of nested arrays/objects).</div><div class="ttdef"><b>Definition:</b> <a href="generic_2ondemand_2base_8h_source.html#l00018">base.h:18</a></div></div>
<div class="ttc" id="anamespacesimdjson_html"><div class="ttname"><a href="namespacesimdjson.html">simdjson</a></div><div class="ttdoc">The top level simdjson namespace, containing everything the library provides.</div><div class="ttdef"><b>Definition:</b> <a href="arm64_2base_8h_source.html#l00008">base.h:8</a></div></div>
<div class="ttc" id="anamespacesimdjson_html_a7b735a3a50ba79e3f7f14df5f77d8da9"><div class="ttname"><a href="namespacesimdjson.html#a7b735a3a50ba79e3f7f14df5f77d8da9">simdjson::error_code</a></div><div class="ttdeci">error_code</div><div class="ttdoc">All possible errors returned by simdjson.</div><div class="ttdef"><b>Definition:</b> <a href="error_8h_source.html#l00019">error.h:19</a></div></div>
<div class="ttc" id="astructsimdjson_1_1_s_i_m_d_j_s_o_n___i_m_p_l_e_m_e_n_t_a_t_i_o_n_1_1implementation__simdjson__result__base_html"><div class="ttname"><a href="structsimdjson_1_1_s_i_m_d_j_s_o_n___i_m_p_l_e_m_e_n_t_a_t_i_o_n_1_1implementation__simdjson__result__base.html">simdjson::SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base</a></div><div class="ttdoc">The result of a simdjson operation that could fail.</div><div class="ttdef"><b>Definition:</b> <a href="implementation__simdjson__result__base_8h_source.html#l00035">implementation_simdjson_result_base.h:35</a></div></div>
<div class="ttc" id="astructsimdjson_1_1simdjson__result_html"><div class="ttname"><a href="structsimdjson_1_1simdjson__result.html">simdjson::simdjson_result</a></div><div class="ttdoc">The result of a simdjson operation that could fail.</div><div class="ttdef"><b>Definition:</b> <a href="error_8h_source.html#l00214">error.h:214</a></div></div>
<div class="ttc" id="astructsimdjson_1_1simdjson__result_html_a23470fcc7f01262019e96d3f3010b4a1"><div class="ttname"><a href="structsimdjson_1_1simdjson__result.html#a23470fcc7f01262019e96d3f3010b4a1">simdjson::simdjson_result::error</a></div><div class="ttdeci">simdjson_inline error_code error() const noexcept</div><div class="ttdoc">The error.</div><div class="ttdef"><b>Definition:</b> <a href="error-inl_8h_source.html#l00131">error-inl.h:131</a></div></div>
<div class="ttc" id="astructsimdjson_1_1simdjson__result_html_af7f6d5a5e979b60d5231449d53dcd9be"><div class="ttname"><a href="structsimdjson_1_1simdjson__result.html#af7f6d5a5e979b60d5231449d53dcd9be">simdjson::simdjson_result::value</a></div><div class="ttdeci">simdjson_inline T &amp; value() &amp;noexcept(false)</div><div class="ttdoc">Get the result value.</div></div>
</div><!-- fragment --></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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_49a0b2767ded4a45005c5d6720a18cd1.html">simdjson</a></li><li class="navelem"><a class="el" href="dir_53368a02099cf3699f2996a5d88d70b6.html">generic</a></li><li class="navelem"><a class="el" href="dir_7796bb4b727f918c96faee1bdd50e49a.html">ondemand</a></li><li class="navelem"><b>token_iterator.h</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>