mirror of
https://github.com/simdjson/simdjson
synced 2026-06-08 17:27:07 +00:00
lemire
507 lines
31 KiB
HTML
507 lines
31 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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>simdjson: Object iteration</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 id="projectrow">
|
|
<td id="projectlogo"><img alt="Logo" src="logotiny.png"/></td>
|
|
<td id="projectalign">
|
|
<div id="projectname">simdjson<span id="projectnumber"> 4.6.4</span>
|
|
</div>
|
|
<div id="projectbrief">Ridiculously Fast JSON</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('group__object.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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">Object iteration</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Methods to iterate and find object fields.
|
|
<a href="#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga46e677764da46ebbe4b0e4dea6672a5f" id="r_ga46e677764da46ebbe4b0e4dea6672a5f"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__object.html#ga46e677764da46ebbe4b0e4dea6672a5f">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::start_object</a> () noexcept</td></tr>
|
|
<tr class="memdesc:ga46e677764da46ebbe4b0e4dea6672a5f"><td class="mdescLeft"> </td><td class="mdescRight">Start an object iteration. <br /></td></tr>
|
|
<tr class="separator:ga46e677764da46ebbe4b0e4dea6672a5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab9563a58e164e9f5f75805cffb3582ec" id="r_gab9563a58e164e9f5f75805cffb3582ec"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__object.html#gab9563a58e164e9f5f75805cffb3582ec">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::start_root_object</a> () noexcept</td></tr>
|
|
<tr class="memdesc:gab9563a58e164e9f5f75805cffb3582ec"><td class="mdescLeft"> </td><td class="mdescRight">Start an object iteration from the root. <br /></td></tr>
|
|
<tr class="separator:gab9563a58e164e9f5f75805cffb3582ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga262c7a1f9320fefb1711fec7b69ef6b1" id="r_ga262c7a1f9320fefb1711fec7b69ef6b1"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="namespacesimdjson.html#a7b735a3a50ba79e3f7f14df5f77d8da9">error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__object.html#ga262c7a1f9320fefb1711fec7b69ef6b1">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::check_root_object</a> () noexcept</td></tr>
|
|
<tr class="memdesc:ga262c7a1f9320fefb1711fec7b69ef6b1"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether an object could be started from the root. <br /></td></tr>
|
|
<tr class="separator:ga262c7a1f9320fefb1711fec7b69ef6b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga192424d19b12648eea73e3d073d5fcac" id="r_ga192424d19b12648eea73e3d073d5fcac"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__object.html#ga192424d19b12648eea73e3d073d5fcac">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::started_object</a> () noexcept</td></tr>
|
|
<tr class="memdesc:ga192424d19b12648eea73e3d073d5fcac"><td class="mdescLeft"> </td><td class="mdescRight">Start an object iteration after the user has already checked and moved past the {. <br /></td></tr>
|
|
<tr class="separator:ga192424d19b12648eea73e3d073d5fcac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa0c31077aeadb6fc627d4c5750e58ecb" id="r_gaa0c31077aeadb6fc627d4c5750e58ecb"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__object.html#gaa0c31077aeadb6fc627d4c5750e58ecb">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::started_root_object</a> () noexcept</td></tr>
|
|
<tr class="memdesc:gaa0c31077aeadb6fc627d4c5750e58ecb"><td class="mdescLeft"> </td><td class="mdescRight">Start an object iteration from the root, after the user has already checked and moved past the {. <br /></td></tr>
|
|
<tr class="separator:gaa0c31077aeadb6fc627d4c5750e58ecb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7956fe38cd8ecfbc8f709aa6f65c92b4" id="r_ga7956fe38cd8ecfbc8f709aa6f65c92b4"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__object.html#ga7956fe38cd8ecfbc8f709aa6f65c92b4">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::has_next_field</a> () noexcept</td></tr>
|
|
<tr class="memdesc:ga7956fe38cd8ecfbc8f709aa6f65c92b4"><td class="mdescLeft"> </td><td class="mdescRight">Moves to the next field in an object. <br /></td></tr>
|
|
<tr class="separator:ga7956fe38cd8ecfbc8f709aa6f65c92b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9fd0d39ec786f26b7ea86f9bc8380bdd" id="r_ga9fd0d39ec786f26b7ea86f9bc8380bdd"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< <a class="el" href="classsimdjson_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_1_1raw__json__string.html">raw_json_string</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__object.html#ga9fd0d39ec786f26b7ea86f9bc8380bdd">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::field_key</a> () noexcept</td></tr>
|
|
<tr class="memdesc:ga9fd0d39ec786f26b7ea86f9bc8380bdd"><td class="mdescLeft"> </td><td class="mdescRight">Get the current field's key. <br /></td></tr>
|
|
<tr class="separator:ga9fd0d39ec786f26b7ea86f9bc8380bdd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaaaf58bcf25e6d30a3469848d36c65a05" id="r_gaaaf58bcf25e6d30a3469848d36c65a05"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="namespacesimdjson.html#a7b735a3a50ba79e3f7f14df5f77d8da9">error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__object.html#gaaaf58bcf25e6d30a3469848d36c65a05">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::field_value</a> () noexcept</td></tr>
|
|
<tr class="memdesc:gaaaf58bcf25e6d30a3469848d36c65a05"><td class="mdescLeft"> </td><td class="mdescRight">Pass the : in the field and move to its value. <br /></td></tr>
|
|
<tr class="separator:gaaaf58bcf25e6d30a3469848d36c65a05"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gacefcaf06811426a241ed97a6948a94ee" id="r_gacefcaf06811426a241ed97a6948a94ee"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="namespacesimdjson.html#a7b735a3a50ba79e3f7f14df5f77d8da9">error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__object.html#gacefcaf06811426a241ed97a6948a94ee">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::find_field</a> (const std::string_view key) noexcept</td></tr>
|
|
<tr class="memdesc:gacefcaf06811426a241ed97a6948a94ee"><td class="mdescLeft"> </td><td class="mdescRight">Find the next field with the given key. <br /></td></tr>
|
|
<tr class="separator:gacefcaf06811426a241ed97a6948a94ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab66bdaf2c97d2cbd2a94a5a3e67ffabc" id="r_gab66bdaf2c97d2cbd2a94a5a3e67ffabc"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__object.html#gab66bdaf2c97d2cbd2a94a5a3e67ffabc">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::find_field_raw</a> (const std::string_view key) noexcept</td></tr>
|
|
<tr class="memdesc:gab66bdaf2c97d2cbd2a94a5a3e67ffabc"><td class="mdescLeft"> </td><td class="mdescRight">Find the next field with the given key, <em>without</em> unescaping. <br /></td></tr>
|
|
<tr class="separator:gab66bdaf2c97d2cbd2a94a5a3e67ffabc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga678e53c38ebaf2323550e7f29e253df9" id="r_ga678e53c38ebaf2323550e7f29e253df9"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__object.html#ga678e53c38ebaf2323550e7f29e253df9">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::find_field_unordered_raw</a> (const std::string_view key) noexcept</td></tr>
|
|
<tr class="memdesc:ga678e53c38ebaf2323550e7f29e253df9"><td class="mdescLeft"> </td><td class="mdescRight">Find the field with the given key without regard to order, and <em>without</em> unescaping. <br /></td></tr>
|
|
<tr class="separator:ga678e53c38ebaf2323550e7f29e253df9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Methods to iterate and find object fields. </p>
|
|
<p>These methods generally <em>assume</em> the value is actually an object; the caller is responsible for keeping track of that fact. </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga262c7a1f9320fefb1711fec7b69ef6b1" name="ga262c7a1f9320fefb1711fec7b69ef6b1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga262c7a1f9320fefb1711fec7b69ef6b1">◆ </a></span>check_root_object()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">simdjson_warn_unused simdjson_inline <a class="el" href="namespacesimdjson.html#a7b735a3a50ba79e3f7f14df5f77d8da9">error_code</a> simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::check_root_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">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks whether an object could be started from the root. </p>
|
|
<p>May be called by start_root_object.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>SUCCESS if it is possible to safely start an object from the root (document level). @error INCORRECT_TYPE if there is no opening { @error TAPE_ERROR if there is no matching } at end of document </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="value__iterator-inl_8h_source.html#l00050">50</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9fd0d39ec786f26b7ea86f9bc8380bdd" name="ga9fd0d39ec786f26b7ea86f9bc8380bdd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9fd0d39ec786f26b7ea86f9bc8380bdd">◆ </a></span>field_key()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">SIMDJSON_POP_DISABLE_WARNINGS simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< <a class="el" href="classsimdjson_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_1_1raw__json__string.html">raw_json_string</a> > simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::field_key </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the current field's key. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="value__iterator-inl_8h_source.html#l00397">397</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaaaf58bcf25e6d30a3469848d36c65a05" name="gaaaf58bcf25e6d30a3469848d36c65a05"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaaaf58bcf25e6d30a3469848d36c65a05">◆ </a></span>field_value()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">simdjson_warn_unused simdjson_inline <a class="el" href="namespacesimdjson.html#a7b735a3a50ba79e3f7f14df5f77d8da9">error_code</a> simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::field_value </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Pass the : in the field and move to its value. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="value__iterator-inl_8h_source.html#l00405">405</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gacefcaf06811426a241ed97a6948a94ee" name="gacefcaf06811426a241ed97a6948a94ee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gacefcaf06811426a241ed97a6948a94ee">◆ </a></span>find_field()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">simdjson_warn_unused simdjson_inline <a class="el" href="namespacesimdjson.html#a7b735a3a50ba79e3f7f14df5f77d8da9">error_code</a> simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::find_field </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string_view </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Find the next field with the given key. </p>
|
|
<p>Assumes you have called next_field() or otherwise matched the previous value.</p>
|
|
<p>This means the iterator must be sitting at the next key:</p>
|
|
<div class="fragment"><div class="line">{ <span class="stringliteral">"a"</span>: 1, <span class="stringliteral">"b"</span>: 2 }</div>
|
|
<div class="line"> ^</div>
|
|
</div><!-- fragment --><p>Key is <em>raw JSON,</em> meaning it will be matched against the verbatim JSON without attempting to unescape it. This works well for typical ASCII and UTF-8 keys (almost all of them), but may fail to match some keys with escapes (\u, <br />
|
|
, etc.). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab66bdaf2c97d2cbd2a94a5a3e67ffabc" name="gab66bdaf2c97d2cbd2a94a5a3e67ffabc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab66bdaf2c97d2cbd2a94a5a3e67ffabc">◆ </a></span>find_field_raw()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< bool > simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::find_field_raw </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string_view </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Find the next field with the given key, <em>without</em> unescaping. </p>
|
|
<p>This assumes object order: it will not find the field if it was already passed when looking for some <em>other</em> field.</p>
|
|
<p>Assumes you have called next_field() or otherwise matched the previous value.</p>
|
|
<p>This means the iterator must be sitting at the next key:</p>
|
|
<div class="fragment"><div class="line">{ <span class="stringliteral">"a"</span>: 1, <span class="stringliteral">"b"</span>: 2 }</div>
|
|
<div class="line"> ^</div>
|
|
</div><!-- fragment --><p>Key is <em>raw JSON,</em> meaning it will be matched against the verbatim JSON without attempting to unescape it. This works well for typical ASCII and UTF-8 keys (almost all of them), but may fail to match some keys with escapes (\u, <br />
|
|
, etc.). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="value__iterator-inl_8h_source.html#l00111">111</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga678e53c38ebaf2323550e7f29e253df9" name="ga678e53c38ebaf2323550e7f29e253df9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga678e53c38ebaf2323550e7f29e253df9">◆ </a></span>find_field_unordered_raw()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">SIMDJSON_PUSH_DISABLE_WARNINGS SIMDJSON_DISABLE_STRICT_OVERFLOW_WARNING simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< bool > simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::find_field_unordered_raw </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string_view </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Find the field with the given key without regard to order, and <em>without</em> unescaping. </p>
|
|
<p>This is an unordered object lookup: if the field is not found initially, it will cycle around and scan from the beginning.</p>
|
|
<p>Assumes you have called next_field() or otherwise matched the previous value.</p>
|
|
<p>This means the iterator must be sitting at the next key:</p>
|
|
<div class="fragment"><div class="line">{ <span class="stringliteral">"a"</span>: 1, <span class="stringliteral">"b"</span>: 2 }</div>
|
|
<div class="line"> ^</div>
|
|
</div><!-- fragment --><p>Key is <em>raw JSON,</em> meaning it will be matched against the verbatim JSON without attempting to unescape it. This works well for typical ASCII and UTF-8 keys (almost all of them), but may fail to match some keys with escapes (\u, <br />
|
|
, etc.). </p>
|
|
<p>When find_field_unordered_raw is called, we can either be pointing at the first key, pointing outside (at the closing brace) or if a key was matched we can be either pointing right afterthe ':' right before the value (that we need skip), or we may have consumed the value and we might be at a comma or at the final brace (ready for a call to <a class="el" href="group__object.html#ga7956fe38cd8ecfbc8f709aa6f65c92b4" title="Moves to the next field in an object.">has_next_field()</a>).</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="value__iterator-inl_8h_source.html#l00208">208</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga7956fe38cd8ecfbc8f709aa6f65c92b4" name="ga7956fe38cd8ecfbc8f709aa6f65c92b4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga7956fe38cd8ecfbc8f709aa6f65c92b4">◆ </a></span>has_next_field()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< bool > simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::has_next_field </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Moves to the next field in an object. </p>
|
|
<p>Looks for , and }. If } is found, the object is finished and the iterator advances past it. Otherwise, it advances to the next value.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>whether there is another field in the object. @error TAPE_ERROR If there is a comma missing between fields. @error TAPE_ERROR If there is a comma, but not enough tokens remaining to have a key, :, and value. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="value__iterator-inl_8h_source.html#l00095">95</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga46e677764da46ebbe4b0e4dea6672a5f" name="ga46e677764da46ebbe4b0e4dea6672a5f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga46e677764da46ebbe4b0e4dea6672a5f">◆ </a></span>start_object()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< bool > simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::start_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">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Start an object iteration. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Whether the object had any fields (returns false for empty). @error INCORRECT_TYPE if there is no opening { </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="value__iterator-inl_8h_source.html#l00026">26</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab9563a58e164e9f5f75805cffb3582ec" name="gab9563a58e164e9f5f75805cffb3582ec"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab9563a58e164e9f5f75805cffb3582ec">◆ </a></span>start_root_object()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< bool > simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::start_root_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">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Start an object iteration from the root. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Whether the object had any fields (returns false for empty). @error INCORRECT_TYPE if there is no opening { @error TAPE_ERROR if there is no matching } at end of document </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="value__iterator-inl_8h_source.html#l00031">31</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga192424d19b12648eea73e3d073d5fcac" name="ga192424d19b12648eea73e3d073d5fcac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga192424d19b12648eea73e3d073d5fcac">◆ </a></span>started_object()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< bool > simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::started_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">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Start an object iteration after the user has already checked and moved past the {. </p>
|
|
<p>Does not move the iterator unless the object is empty ({}).</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Whether the object had any fields (returns false for empty). @error INCOMPLETE_ARRAY_OR_OBJECT If there are no more tokens (implying the <em>parent</em> array or object is incomplete). An INCOMPLETE_ARRAY_OR_OBJECT is an unrecoverable error that invalidates the document. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="value__iterator-inl_8h_source.html#l00036">36</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaa0c31077aeadb6fc627d4c5750e58ecb" name="gaa0c31077aeadb6fc627d4c5750e58ecb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaa0c31077aeadb6fc627d4c5750e58ecb">◆ </a></span>started_root_object()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>< bool > simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::started_root_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">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Start an object iteration from the root, after the user has already checked and moved past the {. </p>
|
|
<p>Does not move the iterator unless the object is empty ({}).</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Whether the object had any fields (returns false for empty). @error INCOMPLETE_ARRAY_OR_OBJECT If there are no more tokens (implying the <em>parent</em> array or object is incomplete). An INCOMPLETE_ARRAY_OR_OBJECT is an unrecoverable error that invalidates the document. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="value__iterator-inl_8h_source.html#l00080">80</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
|
|
|
|
</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="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.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|