admin/simdjson-simdjson
1
0
Fork 0
mirror of https://github.com/simdjson/simdjson synced 2026-06-08 17:27:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
fe19693d7787016b3ac0aa379ef08382e26bd50b
simdjson-simdjson/group__array.html
T
lemire fe19693d77 deploy: 82563dcf70
2024-04-04 18:24:50 +00:00

323 lines
19 KiB
HTML
Raw Blame History

<!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: Array 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 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.9.0</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('group__array.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="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Array iteration</div> </div>
</div><!--header-->
<div class="contents">
<p>Methods to iterate over array elements.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga14e69f9c4949805695e30a576bd9c964"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#ga14e69f9c4949805695e30a576bd9c964">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::start_array</a> () noexcept</td></tr>
<tr class="memdesc:ga14e69f9c4949805695e30a576bd9c964"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check for an opening [ and start an array iteration. <a href="group__array.html#ga14e69f9c4949805695e30a576bd9c964">More...</a><br /></td></tr>
<tr class="separator:ga14e69f9c4949805695e30a576bd9c964"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga334481c295286d926bb3bb912232e225"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#ga334481c295286d926bb3bb912232e225">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::start_root_array</a> () noexcept</td></tr>
<tr class="memdesc:ga334481c295286d926bb3bb912232e225"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check for an opening [ and start an array iteration while at the root. <a href="group__array.html#ga334481c295286d926bb3bb912232e225">More...</a><br /></td></tr>
<tr class="separator:ga334481c295286d926bb3bb912232e225"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1e023cb72adae168dc7157776976ad75"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="namespacesimdjson.html#a7b735a3a50ba79e3f7f14df5f77d8da9">error_code</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#ga1e023cb72adae168dc7157776976ad75">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::check_root_array</a> () noexcept</td></tr>
<tr class="memdesc:ga1e023cb72adae168dc7157776976ad75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether an array could be started from the root. <a href="group__array.html#ga1e023cb72adae168dc7157776976ad75">More...</a><br /></td></tr>
<tr class="separator:ga1e023cb72adae168dc7157776976ad75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga136e508ce46622b86cc901490c807578"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#ga136e508ce46622b86cc901490c807578">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::started_array</a> () noexcept</td></tr>
<tr class="memdesc:ga136e508ce46622b86cc901490c807578"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start an array iteration, after the user has already checked and moved past the [. <a href="group__array.html#ga136e508ce46622b86cc901490c807578">More...</a><br /></td></tr>
<tr class="separator:ga136e508ce46622b86cc901490c807578"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa3428f6c87e63d8a2ba93a3816721066"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gaa3428f6c87e63d8a2ba93a3816721066">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::started_root_array</a> () noexcept</td></tr>
<tr class="memdesc:gaa3428f6c87e63d8a2ba93a3816721066"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start an array iteration from the root, after the user has already checked and moved past the [. <a href="group__array.html#gaa3428f6c87e63d8a2ba93a3816721066">More...</a><br /></td></tr>
<tr class="separator:gaa3428f6c87e63d8a2ba93a3816721066"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga31b0a8ce8734db9413cce31c4d9c8c8d"><td class="memItemLeft" align="right" valign="top">simdjson_warn_unused simdjson_inline <a class="el" href="structsimdjson_1_1simdjson__result.html">simdjson_result</a>&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#ga31b0a8ce8734db9413cce31c4d9c8c8d">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::has_next_element</a> () noexcept</td></tr>
<tr class="memdesc:ga31b0a8ce8734db9413cce31c4d9c8c8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves to the next element in an array. <a href="group__array.html#ga31b0a8ce8734db9413cce31c4d9c8c8d">More...</a><br /></td></tr>
<tr class="separator:ga31b0a8ce8734db9413cce31c4d9c8c8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaba7c4e5787c7295da3a0d73b0db1c890"><td class="memItemLeft" align="right" valign="top"><a id="gaba7c4e5787c7295da3a0d73b0db1c890"></a>
simdjson_warn_unused simdjson_inline value_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gaba7c4e5787c7295da3a0d73b0db1c890">simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::child</a> () const noexcept</td></tr>
<tr class="memdesc:gaba7c4e5787c7295da3a0d73b0db1c890"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a child value iterator. <br /></td></tr>
<tr class="separator:gaba7c4e5787c7295da3a0d73b0db1c890"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Methods to iterate over array elements. </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="ga1e023cb72adae168dc7157776976ad75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1e023cb72adae168dc7157776976ad75">&#9670;&nbsp;</a></span>check_root_array()</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_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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether an array could be started from the root. </p>
<p>May be called by start_root_array.</p>
<dl class="section return"><dt>Returns</dt><dd>SUCCESS if it is possible to safely start an array from the root (document level). @error INCORRECT_TYPE If there is no [. @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#l00446">446</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
</div>
</div>
<a id="ga31b0a8ce8734db9413cce31c4d9c8c8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga31b0a8ce8734db9413cce31c4d9c8c8d">&#9670;&nbsp;</a></span>has_next_element()</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>&lt; bool &gt; simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::has_next_element </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 element in an array. </p>
<p>Looks for , and ]. If ] is found, the array 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 element in the array. @error TAPE_ERROR If there is a comma missing between elements. </dd></dl>
<p class="definition">Definition at line <a class="el" href="value__iterator-inl_8h_source.html#l00482">482</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
</div>
</div>
<a id="ga14e69f9c4949805695e30a576bd9c964"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga14e69f9c4949805695e30a576bd9c964">&#9670;&nbsp;</a></span>start_array()</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>&lt; bool &gt; simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::start_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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check for an opening [ and start an array iteration. </p>
<dl class="section return"><dt>Returns</dt><dd>Whether the array had any elements (returns false for empty). @error INCORRECT_TYPE If there is no [. </dd></dl>
<p class="definition">Definition at line <a class="el" href="value__iterator-inl_8h_source.html#l00414">414</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
</div>
</div>
<a id="ga334481c295286d926bb3bb912232e225"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga334481c295286d926bb3bb912232e225">&#9670;&nbsp;</a></span>start_root_array()</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>&lt; bool &gt; simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::start_root_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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check for an opening [ and start an array iteration while at the root. </p>
<dl class="section return"><dt>Returns</dt><dd>Whether the array had any elements (returns false for empty). @error INCORRECT_TYPE If there is no [. @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#l00419">419</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
</div>
</div>
<a id="ga136e508ce46622b86cc901490c807578"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga136e508ce46622b86cc901490c807578">&#9670;&nbsp;</a></span>started_array()</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>&lt; bool &gt; simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::started_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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Start an array iteration, after the user has already checked and moved past the [. </p>
<p>Does not move the iterator unless the array is empty ([]).</p>
<dl class="section return"><dt>Returns</dt><dd>Whether the array had any elements (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). </dd></dl>
<p class="definition">Definition at line <a class="el" href="value__iterator-inl_8h_source.html#l00431">431</a> of file <a class="el" href="value__iterator-inl_8h_source.html">value_iterator-inl.h</a>.</p>
</div>
</div>
<a id="gaa3428f6c87e63d8a2ba93a3816721066"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa3428f6c87e63d8a2ba93a3816721066">&#9670;&nbsp;</a></span>started_root_array()</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>&lt; bool &gt; simdjson::SIMDJSON_IMPLEMENTATION::ondemand::value_iterator::started_root_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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Start an array iteration from the root, after the user has already checked and moved past the [. </p>
<p>Does not move the iterator unless the array is empty ([]).</p>
<dl class="section return"><dt>Returns</dt><dd>Whether the array had any elements (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). </dd></dl>
<p class="definition">Definition at line <a class="el" href="value__iterator-inl_8h_source.html#l00476">476</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.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink