mirror of
https://github.com/marzer/tomlplusplus.git
synced 2026-02-20 15:22:13 +00:00
1758 lines
171 KiB
HTML
1758 lines
171 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><head>
|
|
<meta charset="utf-8"/>
|
|
<title>toml::array class | toml++ TOML for C++</title>
|
|
<link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" rel="stylesheet"/>
|
|
<link href="m-dark+documentation.compiled.css" rel="stylesheet"/>
|
|
<link href="favicon.ico" rel="icon" type="image/vnd.microsoft.icon"/>
|
|
<meta content="width=device-width, initial-scale=1.0" name="viewport"/>
|
|
<meta content="#22272e" name="theme-color"/>
|
|
<meta content="toml++" name="twitter:title"/>
|
|
<meta content="toml++" property="og:title"/>
|
|
<meta content="toml++" itemprop="name"/>
|
|
<meta content="Mark Gillard" name="author"/>
|
|
<meta content="Mark Gillard" property="article:author"/>
|
|
<meta content="TOML for C++" name="description"/>
|
|
<meta content="TOML for C++" name="twitter:description"/>
|
|
<meta content="TOML for C++" property="og:description"/>
|
|
<meta content="TOML for C++" itemprop="description"/>
|
|
<meta content="telephone=no" name="format-detection"/>
|
|
<meta content="Poxy v0.6.1" name="generator"/>
|
|
<meta content="no-referrer-when-downgrade" name="referrer"/>
|
|
<meta content="gbtcNgKlNiPSMKkYMw4zWFVWGPH_oU93m9n_-nb4qK8" name="google-site-verification"/>
|
|
<link href="poxy-0.6.1.css" rel="stylesheet"/>
|
|
<link href="poxy-0.6.1-dark.css" rel="stylesheet"/>
|
|
<script src="poxy-0.6.1.js"></script>
|
|
</head>
|
|
<body>
|
|
<header><nav id="navigation">
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<a class="m-col-t-8 m-col-m-none m-left-m" href="index.html" id="m-navbar-brand"><img alt="" src="logo.png"/>toml++ <span class="m-thin">TOML for C++</span></a>
|
|
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
|
<a class="m-doc-search-icon" href="#search" onclick="return showSearch()" title="Search"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<path d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z" id="m-doc-search-icon-path"></path>
|
|
</svg></a>
|
|
<a href="#navigation" id="m-navbar-show" title="Show navigation"></a>
|
|
<a href="#" id="m-navbar-hide" title="Hide navigation"></a>
|
|
</div>
|
|
<div class="m-col-t-12 m-show-m m-col-m-none m-right-m" id="m-navbar-collapse">
|
|
<div class="m-row">
|
|
<ol class="m-col-t-6 m-col-m-none">
|
|
<li><a href="namespaces.html">Namespaces</a></li>
|
|
<li><a href="annotated.html">Classes</a></li>
|
|
</ol>
|
|
<ol class="m-col-t-6 m-col-m-none" start="3">
|
|
<li><a class="github poxy-external" href="https://github.com/marzer/tomlplusplus/" target="_blank">Github</a></li>
|
|
<li class="m-show-m"><a class="m-doc-search-icon" href="#search" onclick="return showSearch()" title="Search"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<use href="#m-doc-search-icon-path"></use>
|
|
</svg></a></li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></header>
|
|
<main><article>
|
|
<div class="m-container m-container-inflatable">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<h1>
|
|
<span class="m-breadcrumb"><a href="namespacetoml.html">toml</a>::<wbr/></span>array <span class="m-thin">class</span>
|
|
</h1>
|
|
<p>A TOML array.</p>
|
|
<nav class="m-block m-default poxy-toc">
|
|
<h3>Contents</h3>
|
|
<ul>
|
|
<li>
|
|
Reference
|
|
<ul>
|
|
<li><a href="#base-classes">Base classes</a></li>
|
|
<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
|
|
<li><a href="#pub-methods">Public functions</a></li>
|
|
<li><a href="#equality">Equality</a></li>
|
|
<li><a href="#erasure">Erasure</a></li>
|
|
<li><a href="#insertion-and-emplacement">Insertion and Emplacement</a></li>
|
|
<li><a href="#iteration">Iteration</a></li>
|
|
<li><a href="#metadata">Metadata</a></li>
|
|
<li><a href="#node-views">Node views</a></li>
|
|
<li><a href="#size-and-capacity">Size and Capacity</a></li>
|
|
<li><a href="#type-casts">Type casts</a></li>
|
|
<li><a href="#type-checks">Type checks</a></li>
|
|
<li><a href="#value-retrieval">Value retrieval</a></li>
|
|
<li><a href="#visitation">Visitation</a></li>
|
|
<li><a href="#friends">Friends</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<p>The interface of this type is modeled after <a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/container/vector.html" target="_blank">std::<wbr/>vector</a>, with some additional considerations made for the heterogeneous nature of a TOML array.</p><pre class="m-code"><p class="m-note m-success godbolt"><a class="poxy-external godbolt" href="https://godbolt.org/z/sjK4da" target="_blank">Try this code on Compiler Explorer</a></p><span class="ns">toml</span><span class="o">::</span><span class="ut">table</span><span class="w"> </span><span class="n">tbl</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="n">parse</span><span class="p">(</span><span class="sa">R</span><span class="s">"</span><span class="dl">(</span>
|
|
<span class="s"> arr = [1, 2, 3, 4, 'five']</span>
|
|
<span class="dl">)</span><span class="s">"</span><span class="sa">sv</span><span class="p">);</span>
|
|
|
|
<span class="c1">// get the element as an array</span>
|
|
<span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="o">&</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">*</span><span class="n">tbl</span><span class="p">.</span><span class="n">get_as</span><span class="o"><</span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="o">></span><span class="p">(</span><span class="s">"arr"</span><span class="p">);</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="c1">// increment each element with visit()</span>
|
|
<span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="k">auto</span><span class="o">&&</span><span class="w"> </span><span class="n">elem</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="n">arr</span><span class="p">)</span>
|
|
<span class="p">{</span>
|
|
<span class="w"> </span><span class="n">elem</span><span class="p">.</span><span class="n">visit</span><span class="p">([](</span><span class="k">auto</span><span class="o">&&</span><span class="w"> </span><span class="n">el</span><span class="p">)</span><span class="w"> </span><span class="k">noexcept</span>
|
|
<span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="k">constexpr</span><span class="w"> </span><span class="p">(</span><span class="ns">toml</span><span class="o">::</span><span class="n">is_number</span><span class="o"><</span><span class="k">decltype</span><span class="p">(</span><span class="n">el</span><span class="p">)</span><span class="o">></span><span class="p">)</span>
|
|
<span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="n">el</span><span class="p">)</span><span class="o">++</span><span class="p">;</span>
|
|
<span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="k">constexpr</span><span class="w"> </span><span class="p">(</span><span class="ns">toml</span><span class="o">::</span><span class="n">is_string</span><span class="o"><</span><span class="k">decltype</span><span class="p">(</span><span class="n">el</span><span class="p">)</span><span class="o">></span><span class="p">)</span>
|
|
<span class="w"> </span><span class="n">el</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"six"</span><span class="sa">sv</span><span class="p">;</span>
|
|
<span class="w"> </span><span class="p">});</span>
|
|
<span class="p">}</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="c1">// add and remove elements</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">push_back</span><span class="p">(</span><span class="mi">7</span><span class="p">);</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">push_back</span><span class="p">(</span><span class="mf">8.0f</span><span class="p">);</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">push_back</span><span class="p">(</span><span class="s">"nine"</span><span class="sa">sv</span><span class="p">);</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">erase</span><span class="p">(</span><span class="n">arr</span><span class="p">.</span><span class="n">cbegin</span><span class="p">());</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="c1">// emplace elements</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">emplace_back</span><span class="p">(</span><span class="s">"ten"</span><span class="p">);</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">emplace_back</span><span class="o"><</span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="o">></span><span class="p">(</span><span class="mi">11</span><span class="p">,</span><span class="w"> </span><span class="mf">12.0</span><span class="p">);</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">[ 1, 2, 3, 4, 'five' ]</span>
|
|
<span class="go">[ 2, 3, 4, 5, 'six' ]</span>
|
|
<span class="go">[ 3, 4, 5, 'six', 7, 8.0, 'nine' ]</span>
|
|
<span class="go">[ 3, 4, 5, 'six', 7, 8.0, 'nine', 'ten', [ 11, 12.0 ] ]</span></pre>
|
|
<section id="base-classes">
|
|
<h2><a href="#base-classes">Base classes</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
class <a class="m-doc" href="classtoml_1_1node.html">node</a>
|
|
</dt>
|
|
<dd>A TOML node.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="typeless-methods">
|
|
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="a29fc707cf66a79f3c3d93dadbe3b2719">
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a29fc707cf66a79f3c3d93dadbe3b2719">array</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Default constructor.</dd>
|
|
<dt id="a3bd4611c96ce97d7e6991b7a4312370d">
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a3bd4611c96ce97d7e6991b7a4312370d">array</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1array.html">array</a>&)</span>
|
|
</dt>
|
|
<dd>Copy constructor.</dd>
|
|
<dt id="ac552a63c329598d671e6531b0cef957b">
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ac552a63c329598d671e6531b0cef957b">array</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html">array</a>&& other) <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Move constructor.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ElemType, typename... ElemTypes></div>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="#acb17a58f1fbdb12aeaf8f7d1e8093e5c">array</a>(</span><span class="m-doc-wrap">ElemType&& val,
|
|
ElemTypes && ... vals) <span class="m-label m-flat m-info">explicit</span> </span>
|
|
</dt>
|
|
<dd>Constructs an array with one or more initial elements.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="pub-methods">
|
|
<h2><a href="#pub-methods">Public functions</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="a23b531c4c723f5b110fec0502349e49c">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a23b531c4c723f5b110fec0502349e49c">operator=</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1array.html">array</a>&) -> <a class="m-doc" href="classtoml_1_1array.html">array</a>&</span>
|
|
</dt>
|
|
<dd>Copy-assignment operator.</dd>
|
|
<dt id="a94ca021b96ffca7cc01ebd2b37ce23aa">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a94ca021b96ffca7cc01ebd2b37ce23aa">operator=</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html">array</a>&& rhs) -> <a class="m-doc" href="classtoml_1_1array.html">array</a>& <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Move-assignment operator.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="equality">
|
|
<h2><a href="#equality">Equality</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#af06c7437a0946a9d5e093d903b59f6a4">operator!=</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1array.html">array</a>& lhs,
|
|
const <a class="m-doc" href="classtoml_1_1array.html">array</a>& rhs) -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Inequality operator.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a06cf25e3f80c98d88e041ef9823976c0">operator==</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1array.html">array</a>& lhs,
|
|
const <a class="m-doc" href="classtoml_1_1array.html">array</a>& rhs) -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Equality operator.</dd>
|
|
<dt id="ab87e435c5a41140e60cd2e703df96fbd">
|
|
<div class="m-doc-template">template<typename T></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#ab87e435c5a41140e60cd2e703df96fbd">operator==</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1array.html">array</a>& lhs,
|
|
const <a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html" target="_blank">std::<wbr/>initializer_list</a><T>& rhs) -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Initializer list equality operator.</dd>
|
|
<dt id="a5b3c615e4ba8fd780b966f175070b554">
|
|
<div class="m-doc-template">template<typename T></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a5b3c615e4ba8fd780b966f175070b554">operator==</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1array.html">array</a>& lhs,
|
|
const <a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/container/vector.html" target="_blank">std::<wbr/>vector</a><T>& rhs) -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Vector equality operator.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="erasure">
|
|
<h2><a href="#erasure">Erasure</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="adaa65bf63f29f898c27423306c165d68">
|
|
<span class="m-doc-wrap-bumper">void <a class="m-doc-self" href="#adaa65bf63f29f898c27423306c165d68">clear</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Removes all elements from the array.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a22389a9ed9444fe52be10c4acbdec908">erase</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> pos) -> <a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Removes the specified element from the array.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a723388860d72c9a162137d0293366fb2">erase</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> first,
|
|
<a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> last) -> <a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Removes the elements in the range [first, last) from the array.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a3a550518aab77d3d49a0f238a4154e80">flatten</a>(</span><span class="m-doc-wrap">) & -> <a class="m-doc" href="classtoml_1_1array.html">array</a>&</span>
|
|
</dt>
|
|
<dd>Flattens this array, recursively hoisting the contents of child arrays up into itself.</dd>
|
|
<dt id="a5ea2067eb6014aac937cad430810020b">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a5ea2067eb6014aac937cad430810020b">flatten</a>(</span><span class="m-doc-wrap">) && -> <a class="m-doc" href="classtoml_1_1array.html">array</a>&&</span>
|
|
</dt>
|
|
<dd>Flattens this array, recursively hoisting the contents of child arrays up into itself (rvalue overload).</dd>
|
|
<dt id="af99d72e29cef84f736d91d627b47a1dc">
|
|
<span class="m-doc-wrap-bumper">void <a class="m-doc-self" href="#af99d72e29cef84f736d91d627b47a1dc">pop_back</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Removes the last element from the array.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a5590a52dba222033290c8b5c995466c8">prune</a>(</span><span class="m-doc-wrap">bool recursive = true) & -> <a class="m-doc" href="classtoml_1_1array.html">array</a>& <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Removes empty child arrays and tables.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#abaebb654e760589f43d16ccb3971cae8">prune</a>(</span><span class="m-doc-wrap">bool recursive = true) && -> <a class="m-doc" href="classtoml_1_1array.html">array</a>&& <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Removes empty child arrays and tables (rvalue overload).</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="insertion-and-emplacement">
|
|
<h2><a href="#insertion-and-emplacement">Insertion and Emplacement</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ElemType = void, typename... Args></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a4110b96386b33097a255f3694ac01d4a">emplace</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> pos,
|
|
Args && ... args) -> <a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a></span>
|
|
</dt>
|
|
<dd>Emplaces a new element at a specific position in the array.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ElemType = void, typename... Args></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#ad1383e120e7f8d8fe54e07dab164bd6d">emplace_back</a>(</span><span class="m-doc-wrap">Args && ... args) -> decltype(auto)</span>
|
|
</dt>
|
|
<dd>Emplaces a new element at the end of the array.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ElemType></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a17c7e34b433ea8907186dbb1788c9d37">insert</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> pos,
|
|
ElemType&& val,
|
|
<a class="m-doc" href="namespacetoml.html#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> flags = <a class="m-doc" href="namespacetoml.html#a32f700b152e15c357801e905d626a4fb">preserve_<wbr/>source_<wbr/>value_<wbr/>flags</a>) -> <a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a></span>
|
|
</dt>
|
|
<dd>Inserts a new element at a specific position in the array.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ElemType></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a55a9e6e742e556ea07573d29c23ce7df">insert</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> pos,
|
|
<a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> count,
|
|
ElemType&& val,
|
|
<a class="m-doc" href="namespacetoml.html#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> flags = <a class="m-doc" href="namespacetoml.html#a32f700b152e15c357801e905d626a4fb">preserve_<wbr/>source_<wbr/>value_<wbr/>flags</a>) -> <a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a></span>
|
|
</dt>
|
|
<dd>Repeatedly inserts a new element starting at a specific position in the array.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename Iter></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a60a0d39bfd8721cef23e155f5504d54d">insert</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> pos,
|
|
Iter first,
|
|
Iter last,
|
|
<a class="m-doc" href="namespacetoml.html#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> flags = <a class="m-doc" href="namespacetoml.html#a32f700b152e15c357801e905d626a4fb">preserve_<wbr/>source_<wbr/>value_<wbr/>flags</a>) -> <a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a></span>
|
|
</dt>
|
|
<dd>Inserts a range of elements into the array at a specific position.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ElemType></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a1baecd5d579afb508886572674b89781">insert</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> pos,
|
|
<a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html" target="_blank">std::<wbr/>initializer_list</a><ElemType> ilist,
|
|
<a class="m-doc" href="namespacetoml.html#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> flags = <a class="m-doc" href="namespacetoml.html#a32f700b152e15c357801e905d626a4fb">preserve_<wbr/>source_<wbr/>value_<wbr/>flags</a>) -> <a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a></span>
|
|
</dt>
|
|
<dd>Inserts a range of elements into the array at a specific position.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ElemType></div>
|
|
<span class="m-doc-wrap-bumper">void <a class="m-doc" href="#ab7188537b351ef3a756b54b83e4b05b3">push_back</a>(</span><span class="m-doc-wrap">ElemType&& val,
|
|
<a class="m-doc" href="namespacetoml.html#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> flags = <a class="m-doc" href="namespacetoml.html#a32f700b152e15c357801e905d626a4fb">preserve_<wbr/>source_<wbr/>value_<wbr/>flags</a>)</span>
|
|
</dt>
|
|
<dd>Appends a new element to the end of the array.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ElemType></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a37a8a283e6c1cbeef757b2e59489ee6c">replace</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> pos,
|
|
ElemType&& val,
|
|
<a class="m-doc" href="namespacetoml.html#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> flags = <a class="m-doc" href="namespacetoml.html#a32f700b152e15c357801e905d626a4fb">preserve_<wbr/>source_<wbr/>value_<wbr/>flags</a>) -> <a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a></span>
|
|
</dt>
|
|
<dd>Replaces the element at a specific position in the array with a different value.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="iteration">
|
|
<h2><a href="#iteration">Iteration</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="adfd38318d3390a76f073a83fd2f2aa21">
|
|
using <a class="m-doc-self" href="#adfd38318d3390a76f073a83fd2f2aa21">const_iterator</a> = <a class="m-doc" href="namespacetoml.html#aeba9fe3a193c8b641a1fb3a2096d7c13">const_<wbr/>array_<wbr/>iterator</a>
|
|
</dt>
|
|
<dd>A <a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator" target="_blank">RandomAccessIterator</a> for iterating over const elements in a <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>.</dd>
|
|
<dt id="a62a18471ca7c5b06204d2e26c963f833">
|
|
using <a class="m-doc-self" href="#a62a18471ca7c5b06204d2e26c963f833">iterator</a> = <a class="m-doc" href="namespacetoml.html#ac7e383cde1b8d61dba45292b2b0fcb69">array_<wbr/>iterator</a>
|
|
</dt>
|
|
<dd>A <a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator" target="_blank">RandomAccessIterator</a> for iterating over elements in a <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>.</dd>
|
|
<dt id="a8ee8179ddf1cb44fdf0b8d0700f55c2f">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a8ee8179ddf1cb44fdf0b8d0700f55c2f">begin</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns an iterator to the first element.</dd>
|
|
<dt id="a7cff1526a6d1f6157e0eab231b4757aa">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a7cff1526a6d1f6157e0eab231b4757aa">begin</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns an iterator to the first element.</dd>
|
|
<dt id="a56d1cba006dccc5ad9982b58a8b2ddc1">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a56d1cba006dccc5ad9982b58a8b2ddc1">cbegin</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns an iterator to the first element.</dd>
|
|
<dt id="a50e6b032805760f3930e02923d9a84b0">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a50e6b032805760f3930e02923d9a84b0">cend</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns an iterator to one-past-the-last element.</dd>
|
|
<dt id="adaf908b0cc3e8bcb1ee9ec9ec706d223">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#adaf908b0cc3e8bcb1ee9ec9ec706d223">end</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns an iterator to one-past-the-last element.</dd>
|
|
<dt id="a778b5b807ff7329f7de10237d73f29c2">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a778b5b807ff7329f7de10237d73f29c2">end</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns an iterator to one-past-the-last element.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename Func></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#abb20fc6938b167de1c9ca5b81b6f2f26">for_each</a>(</span><span class="m-doc-wrap">Func&& visitor) & -> <a class="m-doc" href="classtoml_1_1array.html">array</a>& <span class="m-label m-flat m-success">noexcept(…)</span></span>
|
|
</dt>
|
|
<dd>Invokes a visitor on each element in the array.</dd>
|
|
<dt id="a467a3667fe20299a7c898a241da0b2e7">
|
|
<div class="m-doc-template">template<typename Func></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a467a3667fe20299a7c898a241da0b2e7">for_each</a>(</span><span class="m-doc-wrap">Func&& visitor) && -> <a class="m-doc" href="classtoml_1_1array.html">array</a>&& <span class="m-label m-flat m-success">noexcept(…)</span></span>
|
|
</dt>
|
|
<dd>Invokes a visitor on each element in the array (rvalue overload).</dd>
|
|
<dt id="a7ec2f716e2e4020c7bffd3cdf808bab5">
|
|
<div class="m-doc-template">template<typename Func></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a7ec2f716e2e4020c7bffd3cdf808bab5">for_each</a>(</span><span class="m-doc-wrap">Func&& visitor) const & -> const <a class="m-doc" href="classtoml_1_1array.html">array</a>& <span class="m-label m-flat m-success">noexcept(…)</span></span>
|
|
</dt>
|
|
<dd>Invokes a visitor on each element in the array (const lvalue overload).</dd>
|
|
<dt id="a73f67845f89a403902bca57d53fa938e">
|
|
<div class="m-doc-template">template<typename Func></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a73f67845f89a403902bca57d53fa938e">for_each</a>(</span><span class="m-doc-wrap">Func&& visitor) const && -> const <a class="m-doc" href="classtoml_1_1array.html">array</a>&& <span class="m-label m-flat m-success">noexcept(…)</span></span>
|
|
</dt>
|
|
<dd>Invokes a visitor on each element in the array (const rvalue overload).</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="metadata">
|
|
<h2><a href="#metadata">Metadata</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a4a30e611eeddce99e5c48fd80e79b134">source</a>(</span><span class="m-doc-wrap">) const -> const <a class="m-doc" href="structtoml_1_1source__region.html">source_<wbr/>region</a>& <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns the <a class="m-doc poxy-injected" href="structtoml_1_1source__region.html">source region</a> responsible for generating this node during parsing.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="node-views">
|
|
<h2><a href="#node-views">Node views</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a21f64d68f408033ee6610f34d3bf0bcd">at_path</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> path) -> <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><<a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns a view of the subnode matching a fully-qualified "TOML path".</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#ab17e0ffeb05b2ec34b87bc33375c6dce">at_path</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>string_view</a> path) const -> <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><const <a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns a const view of the subnode matching a fully-qualified "TOML path".</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a6c6df9f8faa18019e01ea778a802700f">at_path</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1path.html">toml::<wbr/>path</a>& path) -> <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><<a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns a view of the subnode matching a fully-qualified "TOML path".</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a09b4206b0e980fe961c8f9ba1c503b86">at_path</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1path.html">toml::<wbr/>path</a>& path) const -> <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><const <a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns a const view of the subnode matching a fully-qualified "TOML path".</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a06f8134c629450c0a308798271e98d64">at_path</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>wstring_view</a> path) -> <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><<a class="m-doc" href="classtoml_1_1node.html">node</a>></span>
|
|
</dt>
|
|
<dd>Returns a view of the subnode matching a fully-qualified "TOML path".</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a9fb5f28c07c345f55687dfcb681b33c4">at_path</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html" target="_blank">std::<wbr/>wstring_view</a> path) const -> <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><const <a class="m-doc" href="classtoml_1_1node.html">node</a>></span>
|
|
</dt>
|
|
<dd>Returns a const view of the subnode matching a fully-qualified "TOML path".</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1node.html#ac7d6979c7246d7faee8ca48aadfcee68">operator node_view<const node></a>(</span><span class="m-doc-wrap">) const <span class="m-label m-flat m-info">explicit</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Creates a <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a> pointing to this node (const overload).</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1node.html#a04d800d6ec9342d2ee2a364f05317573">operator node_view<node></a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-info">explicit</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Creates a <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a> pointing to this node.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#af3e492bf3406fb79d50308f5be974c3e">operator[]</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1path.html">toml::<wbr/>path</a>& path) -> <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><<a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns a const view of the subnode matching a fully-qualified "TOML path".</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a462a55fc6e4f7da1108b747165fe17db">operator[]</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1path.html">toml::<wbr/>path</a>& path) const -> <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a><const <a class="m-doc" href="classtoml_1_1node.html">node</a>> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns a const view of the subnode matching a fully-qualified "TOML path".</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="size-and-capacity">
|
|
<h2><a href="#size-and-capacity">Size and Capacity</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="a02b773a1ff337692e78da429030c1610">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a02b773a1ff337692e78da429030c1610">capacity</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns the current max number of elements that may be held in the array's internal storage.</dd>
|
|
<dt id="a5d527ea6bfddad1025e90e4363c822cc">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a5d527ea6bfddad1025e90e4363c822cc">empty</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns true if the array is empty.</dd>
|
|
<dt id="ae65a76add6d756fc7ba8f12a5aad983c">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#ae65a76add6d756fc7ba8f12a5aad983c">max_size</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns the maximum number of elements that can be stored in an array on the current platform.</dd>
|
|
<dt id="a1ba073adc52c3df5ad29cfd7e5daa1d5">
|
|
<span class="m-doc-wrap-bumper">void <a class="m-doc-self" href="#a1ba073adc52c3df5ad29cfd7e5daa1d5">reserve</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> new_capacity)</span>
|
|
</dt>
|
|
<dd>Reserves internal storage capacity up to a pre-determined number of elements.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ElemType></div>
|
|
<span class="m-doc-wrap-bumper">void <a class="m-doc" href="#ab1aca2337ffce7e583a2cf303f16259f">resize</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> new_size,
|
|
ElemType&& default_init_val,
|
|
<a class="m-doc" href="namespacetoml.html#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> default_init_flags = <a class="m-doc" href="namespacetoml.html#a32f700b152e15c357801e905d626a4fb">preserve_<wbr/>source_<wbr/>value_<wbr/>flags</a>)</span>
|
|
</dt>
|
|
<dd>Resizes the array.</dd>
|
|
<dt id="a718c2031ead428aa52912741f6d094aa">
|
|
<span class="m-doc-wrap-bumper">void <a class="m-doc-self" href="#a718c2031ead428aa52912741f6d094aa">shrink_to_fit</a>(</span><span class="m-doc-wrap">)</span>
|
|
</dt>
|
|
<dd>Requests the removal of any unused internal storage capacity.</dd>
|
|
<dt id="af81d7b6a1257ad766a47d9276855a7c9">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#af81d7b6a1257ad766a47d9276855a7c9">size</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns the number of elements in the array.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">void <a class="m-doc" href="#a6e3ac9962c706a88c1001ff83a4084f3">truncate</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> new_size)</span>
|
|
</dt>
|
|
<dd>Shrinks the array to the given size.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="type-casts">
|
|
<h2><a href="#type-casts">Type casts</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
<div class="m-doc-template">template<typename T></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a42b952e50ab41b39c1c5340c010d07f0">as</a>(</span><span class="m-doc-wrap">) -> impl::wrap_node<T>* <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets a pointer to the node as a more specific node type.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename T></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a4013d8bf01b87e77643bef7cdf818a5a">as</a>(</span><span class="m-doc-wrap">) const -> const impl::wrap_node<T>* <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets a pointer to the node as a more specific node type (const overload).</dd>
|
|
<dt id="af3ff6ca450d315c0d62c07631a541d30">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#af3ff6ca450d315c0d62c07631a541d30">as_array</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1array.html">array</a>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns a pointer to the array.</dd>
|
|
<dt id="a6a5d140318f2225d3eece4e0d22287f9">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a6a5d140318f2225d3eece4e0d22287f9">as_array</a>(</span><span class="m-doc-wrap">) const -> const <a class="m-doc" href="classtoml_1_1array.html">array</a>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns a const-qualified pointer to the array.</dd>
|
|
<dt id="a0eb11678929524ce93434a010a73d0bb">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a0eb11678929524ce93434a010a73d0bb">as_boolean</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1value.html">toml::<wbr/>value</a><bool>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="ab65564b9755a57dd901c40f0c95bb3c3">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#ab65564b9755a57dd901c40f0c95bb3c3">as_boolean</a>(</span><span class="m-doc-wrap">) const -> const <a class="m-doc" href="classtoml_1_1value.html">toml::<wbr/>value</a><bool>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="a8615093717a80f59c6c610c4476ef9d2">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a8615093717a80f59c6c610c4476ef9d2">as_date</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1value.html">toml::<wbr/>value</a><<a class="m-doc" href="structtoml_1_1date.html">date</a>>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="ac5823083dcd49f05011c1277cfc40d56">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#ac5823083dcd49f05011c1277cfc40d56">as_date</a>(</span><span class="m-doc-wrap">) const -> const <a class="m-doc" href="classtoml_1_1value.html">toml::<wbr/>value</a><<a class="m-doc" href="structtoml_1_1date.html">date</a>>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="a6ed67d755b8103d7bb17c424c9963f8c">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a6ed67d755b8103d7bb17c424c9963f8c">as_date_time</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1value.html">toml::<wbr/>value</a><<a class="m-doc" href="structtoml_1_1date__time.html">date_<wbr/>time</a>>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="a346db332b3ab5e86b7c7fa392998cdbc">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a346db332b3ab5e86b7c7fa392998cdbc">as_date_time</a>(</span><span class="m-doc-wrap">) const -> const <a class="m-doc" href="classtoml_1_1value.html">toml::<wbr/>value</a><<a class="m-doc" href="structtoml_1_1date__time.html">date_<wbr/>time</a>>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="aaa3653336c15be6941d98f712cc20fa7">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#aaa3653336c15be6941d98f712cc20fa7">as_floating_point</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1value.html">toml::<wbr/>value</a><double>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="a9af651323f3d24317aa9899025161e7d">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a9af651323f3d24317aa9899025161e7d">as_floating_point</a>(</span><span class="m-doc-wrap">) const -> const <a class="m-doc" href="classtoml_1_1value.html">toml::<wbr/>value</a><double>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="adb6b797e3fc5d8239113179a6ab20be9">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#adb6b797e3fc5d8239113179a6ab20be9">as_integer</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1value.html">toml::<wbr/>value</a><<a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">int64_t</a>>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="af8f5b7166a47d4e2995143bba43614a1">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#af8f5b7166a47d4e2995143bba43614a1">as_integer</a>(</span><span class="m-doc-wrap">) const -> const <a class="m-doc" href="classtoml_1_1value.html">toml::<wbr/>value</a><<a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">int64_t</a>>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="a4f252724bcd6222c70cc46743aba7b64">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a4f252724bcd6222c70cc46743aba7b64">as_string</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1value.html">toml::<wbr/>value</a><<a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string.html" target="_blank">std::<wbr/>string</a>>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="ab0cbeaf2ee40151f25690eca80b903ee">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#ab0cbeaf2ee40151f25690eca80b903ee">as_string</a>(</span><span class="m-doc-wrap">) const -> const <a class="m-doc" href="classtoml_1_1value.html">toml::<wbr/>value</a><<a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/string/basic_string.html" target="_blank">std::<wbr/>string</a>>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="a68c92ea559bf24df6fca6ae0d9f8681f">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a68c92ea559bf24df6fca6ae0d9f8681f">as_table</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1table.html">table</a>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="ac9476cb79faad5fcc1b9cc2f86c3b596">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#ac9476cb79faad5fcc1b9cc2f86c3b596">as_table</a>(</span><span class="m-doc-wrap">) const -> const <a class="m-doc" href="classtoml_1_1table.html">table</a>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="a6ff1fb68284ba1fa04aeeb0b3b8eef57">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a6ff1fb68284ba1fa04aeeb0b3b8eef57">as_time</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1value.html">toml::<wbr/>value</a><<a class="m-doc" href="structtoml_1_1time.html">time</a>>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
<dt id="a14925a9548b4ce1df32c86bd2e67ca6f">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a14925a9548b4ce1df32c86bd2e67ca6f">as_time</a>(</span><span class="m-doc-wrap">) const -> const <a class="m-doc" href="classtoml_1_1value.html">toml::<wbr/>value</a><<a class="m-doc" href="structtoml_1_1time.html">time</a>>* <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>nullptr</code>.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="type-checks">
|
|
<h2><a href="#type-checks">Type checks</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
<div class="m-doc-template">template<typename T></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a03e1bbe1a0640953b7105fe40c733118">is</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Checks if a node is a specific type.</dd>
|
|
<dt id="a1f1e4d93f52778613d0a7bcf74a23427">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a1f1e4d93f52778613d0a7bcf74a23427">is_array</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>true</code>.</dd>
|
|
<dt id="a87cd0dcbebcfd661a0ae387255c0605e">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a87cd0dcbebcfd661a0ae387255c0605e">is_array_of_tables</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>true</code> if the array contains only tables.</dd>
|
|
<dt id="abbecf0a51aa3e175bc5748ccf71063d8">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#abbecf0a51aa3e175bc5748ccf71063d8">is_boolean</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>false</code>.</dd>
|
|
<dt id="a792dc3fd7105185415925d4f9ab3ca1d">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a792dc3fd7105185415925d4f9ab3ca1d">is_date</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>false</code>.</dd>
|
|
<dt id="ae844f53a9604fb42f185a91616a72cbd">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#ae844f53a9604fb42f185a91616a72cbd">is_date_time</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>false</code>.</dd>
|
|
<dt id="ab758b93eedbdc27112681f26440bee03">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#ab758b93eedbdc27112681f26440bee03">is_floating_point</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>false</code>.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a79a1fe77c03b33ea2b9d8d0a859c93e6">is_homogeneous</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="namespacetoml.html#abac3e84bbf1f2c90717fca107055f48d">node_<wbr/>type</a> ntype) const -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Checks if the node contains values/elements of only one type.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#ae4e986f9fdb23090f9a0b3716a63e8bb">is_homogeneous</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="namespacetoml.html#abac3e84bbf1f2c90717fca107055f48d">node_<wbr/>type</a> ntype,
|
|
<a class="m-doc" href="classtoml_1_1node.html">node</a>*& first_nonmatch) -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Checks if a node contains values/elements of only one type.</dd>
|
|
<dt id="ad00610c0e18f02516de92b623dc4d0f5">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#ad00610c0e18f02516de92b623dc4d0f5">is_homogeneous</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="namespacetoml.html#abac3e84bbf1f2c90717fca107055f48d">node_<wbr/>type</a> ntype,
|
|
const <a class="m-doc" href="classtoml_1_1node.html">node</a>*& first_nonmatch) const -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Checks if a node contains values/elements of only one type (const overload).</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ElemType = void></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a7d2b7360a2ea44282890e1ded3d3946a">is_homogeneous</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Checks if the node contains values/elements of only one type.</dd>
|
|
<dt id="a78db4190977034c4364674a2958855d4">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a78db4190977034c4364674a2958855d4">is_integer</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>false</code>.</dd>
|
|
<dt id="aa034144c580b3d8a4727c0cfbfebc214">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#aa034144c580b3d8a4727c0cfbfebc214">is_number</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>false</code>.</dd>
|
|
<dt id="aeefdd01a2ce3f6bcd7aecfabd363d06b">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#aeefdd01a2ce3f6bcd7aecfabd363d06b">is_string</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>false</code>.</dd>
|
|
<dt id="ad7ed894e54ad3aaef6d7693c26b887d9">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#ad7ed894e54ad3aaef6d7693c26b887d9">is_table</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>false</code>.</dd>
|
|
<dt id="a2d2fc80512d08af7a934a6d02c7bf506">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a2d2fc80512d08af7a934a6d02c7bf506">is_time</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>false</code>.</dd>
|
|
<dt id="acc533a7fa1ea5c68fce6f4fea5bc419c">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#acc533a7fa1ea5c68fce6f4fea5bc419c">is_value</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <code>false</code>.</dd>
|
|
<dt id="a352b6a99235216f070b5e97976663571">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a352b6a99235216f070b5e97976663571">type</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc" href="namespacetoml.html#abac3e84bbf1f2c90717fca107055f48d">node_<wbr/>type</a> <span class="m-label m-flat m-warning">final</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns <a class="m-doc" href="namespacetoml.html#abac3e84bbf1f2c90717fca107055f48daf1f713c9e000f5d3f280adbd124df4f5">toml::<wbr/>node_type::<wbr/>array</a>.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="value-retrieval">
|
|
<h2><a href="#value-retrieval">Value retrieval</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="a3ab7998d733b37f51c687f7d892c205f">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a3ab7998d733b37f51c687f7d892c205f">at</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> index) -> <a class="m-doc" href="classtoml_1_1node.html">node</a>&</span>
|
|
</dt>
|
|
<dd>Gets a reference to the element at a specific index, throwing <code><a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/error/out_of_range.html" target="_blank">std::<wbr/>out_of_range</a></code> if none existed.</dd>
|
|
<dt id="a57ab2e03da0d45e4298c74b0071b78b5">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a57ab2e03da0d45e4298c74b0071b78b5">at</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> index) const -> const <a class="m-doc" href="classtoml_1_1node.html">node</a>&</span>
|
|
</dt>
|
|
<dd>Gets a reference to the element at a specific index, throwing <code><a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/error/out_of_range.html" target="_blank">std::<wbr/>out_of_range</a></code> if none existed.</dd>
|
|
<dt id="a8a7f389cd399544b6b80277afd50d5d6">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a8a7f389cd399544b6b80277afd50d5d6">back</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1node.html">node</a>& <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns a reference to the last element in the array.</dd>
|
|
<dt id="a0afe372457485cdc90ecee8fc11c2ca6">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a0afe372457485cdc90ecee8fc11c2ca6">back</a>(</span><span class="m-doc-wrap">) const -> const <a class="m-doc" href="classtoml_1_1node.html">node</a>& <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns a reference to the last element in the array.</dd>
|
|
<dt id="a1af85a8c7a82f1c0b48148b7fac8e536">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a1af85a8c7a82f1c0b48148b7fac8e536">front</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1node.html">node</a>& <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns a reference to the first element in the array.</dd>
|
|
<dt id="a8984273ac50a8dba20529ec0cb74a072">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a8984273ac50a8dba20529ec0cb74a072">front</a>(</span><span class="m-doc-wrap">) const -> const <a class="m-doc" href="classtoml_1_1node.html">node</a>& <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns a reference to the first element in the array.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a442d80f39922d05c46b4a7d9a5455585">get</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> index) -> <a class="m-doc" href="classtoml_1_1node.html">node</a>* <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets a pointer to the element at a specific index.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a0fb727f90506419f2e950b5d0e5160a9">get</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> index) const -> const <a class="m-doc" href="classtoml_1_1node.html">node</a>* <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets a pointer to the element at a specific index (const overload).</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ElemType></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a7ab30b16bb727e0595d0bd4adfcd9455">get_as</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> index) -> impl::wrap_node<ElemType>* <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets a pointer to the element at a specific index if it is a particular type.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ElemType></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a17dc014c1c5e64dd9d4f118ddc066ed8">get_as</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> index) const -> const impl::wrap_node<ElemType>* <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets a pointer to the element at a specific index if it is a particular type (const overload).</dd>
|
|
<dt id="a1e471e2bed5daf80b6695c009052bb4e">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a1e471e2bed5daf80b6695c009052bb4e">operator[]</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> index) -> <a class="m-doc" href="classtoml_1_1node.html">node</a>& <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets a reference to the element at a specific index.</dd>
|
|
<dt id="a908e56552c2cfaabc9b73d220792e214">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a908e56552c2cfaabc9b73d220792e214">operator[]</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> index) const -> const <a class="m-doc" href="classtoml_1_1node.html">node</a>& <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets a reference to the element at a specific index.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename T></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a58fde40ef0b172d36bf293c251b25130">ref</a>(</span><span class="m-doc-wrap">) & -> decltype(auto) <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets a raw reference to a node's underlying data.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename T></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#aca651e7fe7f377fe958b20678d08ef14">ref</a>(</span><span class="m-doc-wrap">) && -> decltype(auto) <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets a raw reference to a node's underlying data (rvalue overload).</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename T></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a9794ed57d952d8293ed3278a11e54ca2">ref</a>(</span><span class="m-doc-wrap">) const & -> decltype(auto) <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets a raw reference to a node's underlying data (const lvalue overload).</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename T></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a937af29dc15ef8e1af7950d925341cc3">ref</a>(</span><span class="m-doc-wrap">) const && -> decltype(auto) <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets a raw reference to a node's underlying data (const rvalue overload).</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename T></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a302e5bc2e4796e9b1ae60b002911a007">value</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc" href="namespacetoml.html#af34a9fb3305e419784104609e6bbb7ac">optional</a><T> <span class="m-label m-flat m-success">noexcept(…)</span></span>
|
|
</dt>
|
|
<dd>Gets the value contained by this node.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename T></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a11f4ae869670d876f704f676f0ead81b">value_exact</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc" href="namespacetoml.html#af34a9fb3305e419784104609e6bbb7ac">optional</a><T> <span class="m-label m-flat m-success">noexcept(…)</span></span>
|
|
</dt>
|
|
<dd>Gets the value contained by this node.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename T></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#ad1c332ae403fade90216726105419efc">value_or</a>(</span><span class="m-doc-wrap">T&& default_value) const -> auto <span class="m-label m-flat m-success">noexcept(…)</span></span>
|
|
</dt>
|
|
<dd>Gets the raw value contained by this node, or a default.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="visitation">
|
|
<h2><a href="#visitation">Visitation</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
<div class="m-doc-template">template<typename Func></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#ad47390f3832260db7bf06cd282598240">visit</a>(</span><span class="m-doc-wrap">Func&& visitor) & -> decltype(auto) <span class="m-label m-flat m-success">noexcept(…)</span></span>
|
|
</dt>
|
|
<dd>Invokes a visitor on the node based on the node's concrete type.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename Func></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#a371a03c4b91cfbb8d9ee785c1eacf836">visit</a>(</span><span class="m-doc-wrap">Func&& visitor) && -> decltype(auto) <span class="m-label m-flat m-success">noexcept(…)</span></span>
|
|
</dt>
|
|
<dd>Invokes a visitor on the node based on the node's concrete type (rvalue overload).</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename Func></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#ad4a42e50f923b0fe1efff0a6719dab90">visit</a>(</span><span class="m-doc-wrap">Func&& visitor) const & -> decltype(auto) <span class="m-label m-flat m-success">noexcept(…)</span></span>
|
|
</dt>
|
|
<dd>Invokes a visitor on the node based on the node's concrete type (const lvalue overload).</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename Func></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="classtoml_1_1node.html#ac387cb04111addc0c291ecdd6f299666">visit</a>(</span><span class="m-doc-wrap">Func&& visitor) const && -> decltype(auto) <span class="m-label m-flat m-success">noexcept(…)</span></span>
|
|
</dt>
|
|
<dd>Invokes a visitor on the node based on the node's concrete type (const rvalue overload).</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="friends">
|
|
<h2><a href="#friends">Friends</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#ada82b30641e7546cfe89ece1db7436cc">operator<<</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html" target="_blank">std::<wbr/>ostream</a>& lhs,
|
|
const <a class="m-doc" href="classtoml_1_1array.html">array</a>& rhs) -> <a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html" target="_blank">std::<wbr/>ostream</a>&</span>
|
|
</dt>
|
|
<dd>Prints the array out to a stream as formatted TOML.</dd>
|
|
</dl>
|
|
</section>
|
|
<section>
|
|
<h2>Function documentation</h2>
|
|
<section class="m-doc-details" id="acb17a58f1fbdb12aeaf8f7d1e8093e5c"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ElemType, typename... ElemTypes>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper"> toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#acb17a58f1fbdb12aeaf8f7d1e8093e5c">array</a>(</span><span class="m-doc-wrap">ElemType&& val,
|
|
ElemTypes && ... vals) <span class="m-label m-info">explicit</span> </span></span>
|
|
</h3>
|
|
<p>Constructs an array with one or more initial elements.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Template parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">ElemType</td>
|
|
<td>One of the TOML node or value types (or a type promotable to one).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ElemTypes</td>
|
|
<td>One of the TOML node or value types (or a type promotable to one).</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>val</td>
|
|
<td>The node or value used to initialize element 0.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>vals</td>
|
|
<td>The nodes or values used to initialize elements 1...N.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mf">2.0</span><span class="p">,</span><span class="w"> </span><span class="s">"three"</span><span class="sa">sv</span><span class="p">,</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span><span class="w"> </span><span class="mi">5</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">};</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">[ 1, 2.0, 'three', [ 4, 5 ] ]</span></pre><aside class="m-note m-default"><h4>Remark</h4><div><p>If you need to construct an array with one child array element, the array's move constructor will take precedence and perform a move-construction instead. You can use <a class="m-doc" href="structtoml_1_1inserter.html">toml::<wbr/>inserter</a> to suppress this behaviour:</p><pre class="m-code"><span class="c1">// desired result: [ [ 42 ] ]</span>
|
|
<span class="k">auto</span><span class="w"> </span><span class="n">bad</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">42</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">}</span>
|
|
<span class="k">auto</span><span class="w"> </span><span class="n">good</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">inserter</span><span class="p">{</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">42</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">}</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"bad: "</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">bad</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"good:"</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">good</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">bad: [ 42 ]</span>
|
|
<span class="go">good: [ [ 42 ] ]</span></pre></div></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="af06c7437a0946a9d5e093d903b59f6a4"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">bool toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#af06c7437a0946a9d5e093d903b59f6a4">operator!=</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1array.html">array</a>& lhs,
|
|
const <a class="m-doc" href="classtoml_1_1array.html">array</a>& rhs) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Inequality operator.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">lhs</td>
|
|
<td>The LHS array.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>rhs</td>
|
|
<td>The RHS array.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>True if the arrays did not contain the same elements.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a06cf25e3f80c98d88e041ef9823976c0"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">bool toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a06cf25e3f80c98d88e041ef9823976c0">operator==</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1array.html">array</a>& lhs,
|
|
const <a class="m-doc" href="classtoml_1_1array.html">array</a>& rhs) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Equality operator.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">lhs</td>
|
|
<td>The LHS array.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>rhs</td>
|
|
<td>The RHS array.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>True if the arrays contained the same elements.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a22389a9ed9444fe52be10c4acbdec908"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a> toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a22389a9ed9444fe52be10c4acbdec908">erase</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> pos) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Removes the specified element from the array.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">pos</td>
|
|
<td>Iterator to the element being erased.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>Iterator to the first element immediately following the removed element.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="p">};</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">erase</span><span class="p">(</span><span class="n">arr</span><span class="p">.</span><span class="n">cbegin</span><span class="p">()</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mi">1</span><span class="p">);</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">[ 1, 2, 3 ]</span>
|
|
<span class="go">[ 1, 3 ]</span></pre>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a723388860d72c9a162137d0293366fb2"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a> toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a723388860d72c9a162137d0293366fb2">erase</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> first,
|
|
<a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> last) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Removes the elements in the range [first, last) from the array.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">first</td>
|
|
<td>Iterator to the first element being erased.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>last</td>
|
|
<td>Iterator to the one-past-the-last element being erased.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>Iterator to the first element immediately following the last removed element.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="s">"bad"</span><span class="p">,</span><span class="w"> </span><span class="s">"karma"</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="p">};</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">erase</span><span class="p">(</span><span class="n">arr</span><span class="p">.</span><span class="n">cbegin</span><span class="p">()</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="n">arr</span><span class="p">.</span><span class="n">cbegin</span><span class="p">()</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mi">3</span><span class="p">);</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">[ 1, 'bad', 'karma', 3 ]</span>
|
|
<span class="go">[ 1, 3 ]</span></pre>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a3a550518aab77d3d49a0f238a4154e80"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1array.html">array</a>& toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a3a550518aab77d3d49a0f238a4154e80">flatten</a>(</span><span class="m-doc-wrap">) &</span></span>
|
|
</h3>
|
|
<p>Flattens this array, recursively hoisting the contents of child arrays up into itself.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<tfoot>
|
|
<tr>
|
|
<th style="width: 1%">Returns</th>
|
|
<td>A reference to the array.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">5</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">},</span><span class="w"> </span><span class="mi">6</span><span class="p">,</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{}</span><span class="w"> </span><span class="p">};</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">flatten</span><span class="p">();</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">[ 1, 2, [ 3, 4, [ 5 ] ], 6, [] ]</span>
|
|
<span class="go">[ 1, 2, 3, 4, 5, 6 ]</span></pre><aside class="m-note m-default"><h4>Remark</h4><p>Arrays inside child tables are not flattened.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a5590a52dba222033290c8b5c995466c8"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1array.html">array</a>& toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a5590a52dba222033290c8b5c995466c8">prune</a>(</span><span class="m-doc-wrap">bool recursive = true) & <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Removes empty child arrays and tables.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">recursive</td>
|
|
<td>Should child arrays and tables themselves be pruned?</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A reference to the array.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="p">},</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">},</span><span class="w"> </span><span class="mi">4</span><span class="w"> </span><span class="p">};</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">prune</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">[ 1, 2, [], [ 3, [] ], 4 ]</span>
|
|
<span class="go">[ 1, 2, [ 3 ], 4 ]</span></pre>
|
|
</div></section>
|
|
<section class="m-doc-details" id="abaebb654e760589f43d16ccb3971cae8"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1array.html">array</a>&& toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#abaebb654e760589f43d16ccb3971cae8">prune</a>(</span><span class="m-doc-wrap">bool recursive = true) && <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Removes empty child arrays and tables (rvalue overload).</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">recursive</td>
|
|
<td>Should child arrays and tables themselves be pruned?</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>An rvalue reference to the array.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a4110b96386b33097a255f3694ac01d4a"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ElemType = void, typename... Args>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a> toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a4110b96386b33097a255f3694ac01d4a">emplace</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> pos,
|
|
Args && ... args)</span></span>
|
|
</h3>
|
|
<p>Emplaces a new element at a specific position in the array.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Template parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">ElemType</td>
|
|
<td><a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>, <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>, or any native TOML value type.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Args</td>
|
|
<td>Value constructor argument types.</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>pos</td>
|
|
<td>The insertion position.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>args</td>
|
|
<td>Arguments to forward to the value's constructor.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>An iterator to the inserted element.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="p">};</span>
|
|
|
|
<span class="c1">//add a string using <a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/string/basic_string" target="_blank">std::string</a>'s substring constructor</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">emplace</span><span class="o"><</span><span class="ns">std</span><span class="o">::</span><span class="ut">string</span><span class="o">></span><span class="p">(</span><span class="n">arr</span><span class="p">.</span><span class="n">cbegin</span><span class="p">()</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="s">"this is not a drill"</span><span class="sa">sv</span><span class="p">,</span><span class="w"> </span><span class="mi">14</span><span class="p">,</span><span class="w"> </span><span class="mi">5</span><span class="p">);</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">[ 1, 'drill', 2 ]</span></pre><aside class="m-note m-default"><h4>Remark</h4><p>There is no difference between <a class="m-doc" href="classtoml_1_1array.html#a17c7e34b433ea8907186dbb1788c9d37">insert()</a> and <a class="m-doc" href="classtoml_1_1array.html#a4110b96386b33097a255f3694ac01d4a">emplace()</a> for trivial value types (floats, ints, bools).</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="ad1383e120e7f8d8fe54e07dab164bd6d"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ElemType = void, typename... Args>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper">decltype(auto) toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ad1383e120e7f8d8fe54e07dab164bd6d">emplace_back</a>(</span><span class="m-doc-wrap">Args && ... args)</span></span>
|
|
</h3>
|
|
<p>Emplaces a new element at the end of the array.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Template parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">ElemType</td>
|
|
<td><a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>, <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>, or a native TOML value type</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Args</td>
|
|
<td>Element constructor argument types.</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>args</td>
|
|
<td>Arguments to forward to the elements's constructor.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A reference to the newly-constructed element.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="p">};</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">emplace_back</span><span class="o"><</span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="o">></span><span class="p">(</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="s">"four"</span><span class="sa">sv</span><span class="p">);</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">[ 1, 2, [ 3, 'four' ] ]</span></pre><aside class="m-note m-default"><h4>Remark</h4><p>There is no difference between <a class="m-doc" href="classtoml_1_1array.html#ab7188537b351ef3a756b54b83e4b05b3">push_<wbr/>back()</a> and <a class="m-doc" href="classtoml_1_1array.html#ad1383e120e7f8d8fe54e07dab164bd6d">emplace_<wbr/>back()</a> For trivial value types (floats, ints, bools).</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a17c7e34b433ea8907186dbb1788c9d37"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ElemType>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a> toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a17c7e34b433ea8907186dbb1788c9d37">insert</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> pos,
|
|
ElemType&& val,
|
|
<a class="m-doc" href="namespacetoml.html#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> flags = <a class="m-doc" href="namespacetoml.html#a32f700b152e15c357801e905d626a4fb">preserve_<wbr/>source_<wbr/>value_<wbr/>flags</a>)</span></span>
|
|
</h3>
|
|
<p>Inserts a new element at a specific position in the array.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Template parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">ElemType</td>
|
|
<td><a class="m-doc" href="classtoml_1_1node.html">toml::<wbr/>node</a>, <a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a>, <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>, <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>, or a native TOML value type (or a type promotable to one).</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>pos</td>
|
|
<td>The insertion position.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>val</td>
|
|
<td>The node or value being inserted.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>flags</td>
|
|
<td>Value flags to apply to new values.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td><strong><em>Valid input:</em></strong> An iterator to the newly-inserted element. <strong><em>Input is a null <a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a>:</em></strong> <a class="m-doc" href="classtoml_1_1array.html#adaf908b0cc3e8bcb1ee9ec9ec706d223">end()</a></td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="p">};</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">insert</span><span class="p">(</span><span class="n">arr</span><span class="p">.</span><span class="n">cbegin</span><span class="p">()</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="s">"two"</span><span class="p">);</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">insert</span><span class="p">(</span><span class="n">arr</span><span class="p">.</span><span class="n">cend</span><span class="p">(),</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span><span class="w"> </span><span class="mi">5</span><span class="w"> </span><span class="p">});</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">[ 1, 'two', 3, [ 4, 5 ] ]</span></pre><aside class="m-note m-warning"><h4>Attention</h4><p>The return value will always be <code><a class="m-doc" href="classtoml_1_1array.html#adaf908b0cc3e8bcb1ee9ec9ec706d223">end()</a></code> if the input value was a null <a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a>, because no insertion can take place. This is the only circumstance in which this can occur.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a55a9e6e742e556ea07573d29c23ce7df"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ElemType>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a> toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a55a9e6e742e556ea07573d29c23ce7df">insert</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> pos,
|
|
<a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> count,
|
|
ElemType&& val,
|
|
<a class="m-doc" href="namespacetoml.html#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> flags = <a class="m-doc" href="namespacetoml.html#a32f700b152e15c357801e905d626a4fb">preserve_<wbr/>source_<wbr/>value_<wbr/>flags</a>)</span></span>
|
|
</h3>
|
|
<p>Repeatedly inserts a new element starting at a specific position in the array.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Template parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">ElemType</td>
|
|
<td><a class="m-doc" href="classtoml_1_1node.html">toml::<wbr/>node</a>, <a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a>, <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>, <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>, or a native TOML value type (or a type promotable to one).</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>pos</td>
|
|
<td>The insertion position.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>count</td>
|
|
<td>The number of times the node or value should be inserted.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>val</td>
|
|
<td>The node or value being inserted.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>flags</td>
|
|
<td>Value flags to apply to new values.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td><strong><em>Valid input:</em></strong> An iterator to the newly-inserted element. <strong><em>count == 0:</em></strong> A copy of pos <strong><em>Input is a null <a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a>:</em></strong> <a class="m-doc" href="classtoml_1_1array.html#adaf908b0cc3e8bcb1ee9ec9ec706d223">end()</a></td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span>
|
|
<span class="w"> </span><span class="s">"with an evil twinkle in its eye the goose said"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"and immediately we knew peace was never an option."</span>
|
|
<span class="p">};</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">insert</span><span class="p">(</span><span class="n">arr</span><span class="p">.</span><span class="n">cbegin</span><span class="p">()</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="s">"honk"</span><span class="p">);</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">[</span>
|
|
<span class="go"> 'with an evil twinkle in its eye the goose said',</span>
|
|
<span class="go"> 'honk',</span>
|
|
<span class="go"> 'honk',</span>
|
|
<span class="go"> 'honk',</span>
|
|
<span class="go"> 'and immediately we knew peace was never an option.'</span>
|
|
<span class="go">]</span></pre><aside class="m-note m-warning"><h4>Attention</h4><p>The return value will always be <code><a class="m-doc" href="classtoml_1_1array.html#adaf908b0cc3e8bcb1ee9ec9ec706d223">end()</a></code> if the input value was a null <a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a>, because no insertion can take place. This is the only circumstance in which this can occur.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a60a0d39bfd8721cef23e155f5504d54d"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename Iter>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a> toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a60a0d39bfd8721cef23e155f5504d54d">insert</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> pos,
|
|
Iter first,
|
|
Iter last,
|
|
<a class="m-doc" href="namespacetoml.html#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> flags = <a class="m-doc" href="namespacetoml.html#a32f700b152e15c357801e905d626a4fb">preserve_<wbr/>source_<wbr/>value_<wbr/>flags</a>)</span></span>
|
|
</h3>
|
|
<p>Inserts a range of elements into the array at a specific position.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Template parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">Iter</td>
|
|
<td>An iterator type. Must satisfy <a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/named_req/ForwardIterator" target="_blank">ForwardIterator</a>.</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>pos</td>
|
|
<td>The insertion position.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>first</td>
|
|
<td>Iterator to the first node or value being inserted.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>last</td>
|
|
<td>Iterator to the one-past-the-last node or value being inserted.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>flags</td>
|
|
<td>Value flags to apply to new values.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td><strong><em>Valid input:</em></strong> An iterator to the first newly-inserted element. <strong><em>first >= last:</em></strong> A copy of pos <strong><em>All objects in the range were null <a class="m-doc poxy-injected" href="classtoml_1_1node__view.html">toml::node_views</a>:</em></strong> A copy of pos</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a1baecd5d579afb508886572674b89781"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ElemType>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a> toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a1baecd5d579afb508886572674b89781">insert</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> pos,
|
|
<a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html" target="_blank">std::<wbr/>initializer_list</a><ElemType> ilist,
|
|
<a class="m-doc" href="namespacetoml.html#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> flags = <a class="m-doc" href="namespacetoml.html#a32f700b152e15c357801e905d626a4fb">preserve_<wbr/>source_<wbr/>value_<wbr/>flags</a>)</span></span>
|
|
</h3>
|
|
<p>Inserts a range of elements into the array at a specific position.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Template parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">ElemType</td>
|
|
<td><a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a>, <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>, <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>, or a native TOML value type (or a type promotable to one).</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>pos</td>
|
|
<td>The insertion position.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ilist</td>
|
|
<td>An initializer list containing the values to be inserted.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>flags</td>
|
|
<td>Value flags to apply to new values.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td><strong><em>Valid input:</em></strong> An iterator to the first newly-inserted element. <strong><em>Input list is empty:</em></strong> A copy of pos <strong><em>All objects in the list were null <a class="m-doc poxy-injected" href="classtoml_1_1node__view.html">toml::node_views</a>:</em></strong> A copy of pos</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="ab7188537b351ef3a756b54b83e4b05b3"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ElemType>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper">void toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ab7188537b351ef3a756b54b83e4b05b3">push_back</a>(</span><span class="m-doc-wrap">ElemType&& val,
|
|
<a class="m-doc" href="namespacetoml.html#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> flags = <a class="m-doc" href="namespacetoml.html#a32f700b152e15c357801e905d626a4fb">preserve_<wbr/>source_<wbr/>value_<wbr/>flags</a>)</span></span>
|
|
</h3>
|
|
<p>Appends a new element to the end of the array.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Template parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">ElemType</td>
|
|
<td><a class="m-doc" href="classtoml_1_1node.html">toml::<wbr/>node</a>, <a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a>, <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>, <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>, or a native TOML value type</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>val</td>
|
|
<td>The node or value being added.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>flags</td>
|
|
<td>Value flags to apply to new values.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="p">};</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">push_back</span><span class="p">(</span><span class="mi">3</span><span class="p">);</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">push_back</span><span class="p">(</span><span class="mf">4.0</span><span class="p">);</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">push_back</span><span class="p">(</span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w"> </span><span class="s">"six"</span><span class="sa">sv</span><span class="w"> </span><span class="p">});</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">[ 1, 2, 3, 4.0, [ 5, 'six' ] ]</span></pre><aside class="m-note m-warning"><h4>Attention</h4><p>No insertion takes place if the input value is a null <a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a>. This is the only circumstance in which this can occur.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a37a8a283e6c1cbeef757b2e59489ee6c"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ElemType>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1array.html#a62a18471ca7c5b06204d2e26c963f833">iterator</a> toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a37a8a283e6c1cbeef757b2e59489ee6c">replace</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1array.html#adfd38318d3390a76f073a83fd2f2aa21">const_<wbr/>iterator</a> pos,
|
|
ElemType&& val,
|
|
<a class="m-doc" href="namespacetoml.html#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> flags = <a class="m-doc" href="namespacetoml.html#a32f700b152e15c357801e905d626a4fb">preserve_<wbr/>source_<wbr/>value_<wbr/>flags</a>)</span></span>
|
|
</h3>
|
|
<p>Replaces the element at a specific position in the array with a different value.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Template parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">ElemType</td>
|
|
<td><a class="m-doc" href="classtoml_1_1node.html">toml::<wbr/>node</a>, <a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a>, <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>, <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>, or a native TOML value type (or a type promotable to one).</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>pos</td>
|
|
<td>The insertion position.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>val</td>
|
|
<td>The node or value being inserted.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>flags</td>
|
|
<td>Value flags to apply to new values.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td><strong><em>Valid input:</em></strong> An iterator to the replaced element. <strong><em>Input is a null <a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a>:</em></strong> <a class="m-doc" href="classtoml_1_1array.html#adaf908b0cc3e8bcb1ee9ec9ec706d223">end()</a></td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="p">};</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">replace</span><span class="p">(</span><span class="n">arr</span><span class="p">.</span><span class="n">cbegin</span><span class="p">()</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="s">"two"</span><span class="p">);</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">[ 1, 2, 3 ]</span>
|
|
<span class="go">[ 1, 'two', 3 ]</span></pre><aside class="m-note m-warning"><h4>Attention</h4><p>The return value will always be <code><a class="m-doc" href="classtoml_1_1array.html#adaf908b0cc3e8bcb1ee9ec9ec706d223">end()</a></code> if the input value was a null <a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a>, because no replacement can take place. This is the only circumstance in which this can occur.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="abb20fc6938b167de1c9ca5b81b6f2f26"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename Func>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1array.html">array</a>& toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#abb20fc6938b167de1c9ca5b81b6f2f26">for_each</a>(</span><span class="m-doc-wrap">Func&& visitor) & <span class="m-label m-success">noexcept(…)</span></span></span>
|
|
</h3>
|
|
<p>Invokes a visitor on each element in the array.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Template parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">Func</td>
|
|
<td><p>A callable type invocable with one of the following signatures:</p><ul><li><code>func(elem, index)</code></li><li><code>func(elem)</code></li><li><code>func(index, elem)</code></li></ul><p>Where:</p><ul><li><code>elem</code> will recieve the element as it's concrete type with cvref-qualifications matching the array</li><li><code>index</code> will recieve a <code><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a></code> indicating the element's index</li></ul><p>Visitors returning <code>bool</code> (or something convertible to <code>bool</code>) will cause iteration to stop if they return <code>false</code>.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>visitor</td>
|
|
<td>The visitor object.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A reference to the array.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="w"> </span><span class="n">arr</span><span class="p">{</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mf">3.0</span><span class="p">,</span><span class="w"> </span><span class="s">"four"</span><span class="p">,</span><span class="w"> </span><span class="s">"five"</span><span class="p">,</span><span class="w"> </span><span class="mi">6</span><span class="w"> </span><span class="p">};</span>
|
|
|
|
<span class="c1">// select only the integers using a strongly-typed visitor</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">for_each</span><span class="p">([](</span><span class="ns">toml</span><span class="o">::</span><span class="ut">value</span><span class="o"><</span><span class="ut"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">int64_t</a></span><span class="o">>&</span><span class="w"> </span><span class="n">elem</span><span class="p">)</span>
|
|
<span class="p">{</span>
|
|
<span class="w"> </span><span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">elem</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">", "</span><span class="p">;</span>
|
|
<span class="p">});</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="c1">// select all the numeric values using a generic visitor + is_number<> metafunction</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">for_each</span><span class="p">([](</span><span class="k">auto</span><span class="o">&&</span><span class="w"> </span><span class="n">elem</span><span class="p">)</span>
|
|
<span class="p">{</span>
|
|
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="k">constexpr</span><span class="w"> </span><span class="p">(</span><span class="ns">toml</span><span class="o">::</span><span class="n">is_number</span><span class="o"><</span><span class="k">decltype</span><span class="p">(</span><span class="n">elem</span><span class="p">)</span><span class="o">></span><span class="p">)</span>
|
|
<span class="w"> </span><span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">elem</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">", "</span><span class="p">;</span>
|
|
<span class="p">});</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="c1">// select all the numeric values until we encounter something non-numeric</span>
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">for_each</span><span class="p">([](</span><span class="k">auto</span><span class="o">&&</span><span class="w"> </span><span class="n">elem</span><span class="p">)</span>
|
|
<span class="p">{</span>
|
|
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="k">constexpr</span><span class="w"> </span><span class="p">(</span><span class="ns">toml</span><span class="o">::</span><span class="n">is_number</span><span class="o"><</span><span class="k">decltype</span><span class="p">(</span><span class="n">elem</span><span class="p">)</span><span class="o">></span><span class="p">)</span>
|
|
<span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">elem</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">", "</span><span class="p">;</span>
|
|
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// "keep going"</span>
|
|
<span class="w"> </span><span class="p">}</span>
|
|
<span class="w"> </span><span class="k">else</span>
|
|
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">false</span><span class="p">;</span><span class="w"> </span><span class="c1">// "stop!"</span>
|
|
|
|
<span class="p">});</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">0, 1, 2, 6,</span>
|
|
<span class="go">0, 1, 2, 3.0, 6,</span>
|
|
<span class="go">0, 1, 2, 3.0,</span></pre><aside class="m-note m-default"><h4>See also</h4><p><a class="m-doc" href="classtoml_1_1node.html#ad47390f3832260db7bf06cd282598240">node::<wbr/>visit()</a></p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="ab1aca2337ffce7e583a2cf303f16259f"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ElemType>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper">void toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ab1aca2337ffce7e583a2cf303f16259f">resize</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> new_size,
|
|
ElemType&& default_init_val,
|
|
<a class="m-doc" href="namespacetoml.html#a73eba6a34e7c7c4a4d311100800e1bb5">value_<wbr/>flags</a> default_init_flags = <a class="m-doc" href="namespacetoml.html#a32f700b152e15c357801e905d626a4fb">preserve_<wbr/>source_<wbr/>value_<wbr/>flags</a>)</span></span>
|
|
</h3>
|
|
<p>Resizes the array.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Template parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">ElemType</td>
|
|
<td><a class="m-doc" href="classtoml_1_1node.html">toml::<wbr/>node</a>, <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>, <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>, or a native TOML value type (or a type promotable to one).</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>new_size</td>
|
|
<td>The number of elements the array will have after resizing.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>default_init_val</td>
|
|
<td>The node or value used to initialize new elements if the array needs to grow.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>default_init_flags</td>
|
|
<td>Value flags to apply to new values created if new elements are created by growing.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<pre class="m-code"><p class="m-note m-success godbolt"><a class="poxy-external godbolt" href="https://godbolt.org/z/W5zqx3" target="_blank">Try this code on Compiler Explorer</a></p><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="p">};</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">resize</span><span class="p">(</span><span class="mi">6</span><span class="p">,</span><span class="w"> </span><span class="mi">42</span><span class="p">);</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">resize</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">);</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">[ 1, 2, 3 ]</span>
|
|
<span class="go">[ 1, 2, 3, 42, 42, 42 ]</span>
|
|
<span class="go">[ 1, 2 ]</span></pre>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a6e3ac9962c706a88c1001ff83a4084f3"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">void toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a6e3ac9962c706a88c1001ff83a4084f3">truncate</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> new_size)</span></span>
|
|
</h3>
|
|
<p>Shrinks the array to the given size.</p>
|
|
<pre class="m-code"><p class="m-note m-success godbolt"><a class="poxy-external godbolt" href="https://godbolt.org/z/rxEzK5" target="_blank">Try this code on Compiler Explorer</a></p><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="p">};</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">truncate</span><span class="p">(</span><span class="mi">5</span><span class="p">);</span><span class="w"> </span><span class="c1">// no-op</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="n">arr</span><span class="p">.</span><span class="n">truncate</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">[ 1, 2, 3 ]</span>
|
|
<span class="go">[ 1, 2, 3 ]</span>
|
|
<span class="go">[ 1]</span></pre><aside class="m-note m-default"><h4>Remark</h4><p>Does nothing if the requested size is larger than or equal to the current size.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a79a1fe77c03b33ea2b9d8d0a859c93e6"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">bool toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a79a1fe77c03b33ea2b9d8d0a859c93e6">is_homogeneous</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="namespacetoml.html#abac3e84bbf1f2c90717fca107055f48d">node_<wbr/>type</a> ntype) const <span class="m-label m-warning">final</span> <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Checks if the node contains values/elements of only one type.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">ntype</td>
|
|
<td>A TOML node type.<br/><strong><em><a class="m-doc" href="namespacetoml.html#abac3e84bbf1f2c90717fca107055f48da334c4a4c42fdb79d7ebc3e73b517e6f8">toml::<wbr/>node_type::<wbr/>none</a>:</em></strong> "is every element the same type?" <strong><em>Anything else:</em></strong> "is every element one of these?"</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>True if the node was homogeneous.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="p">};</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"homogenous: "</span><span class="sa">sv</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="p">.</span><span class="n">is_homogeneous</span><span class="p">(</span><span class="ns">toml</span><span class="o">::</span><span class="ut">node_type</span><span class="o">::</span><span class="ne">none</span><span class="p">)</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"all floats: "</span><span class="sa">sv</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="p">.</span><span class="n">is_homogeneous</span><span class="p">(</span><span class="ns">toml</span><span class="o">::</span><span class="ut">node_type</span><span class="o">::</span><span class="ne">floating_point</span><span class="p">)</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"all arrays: "</span><span class="sa">sv</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="p">.</span><span class="n">is_homogeneous</span><span class="p">(</span><span class="ns">toml</span><span class="o">::</span><span class="ut">node_type</span><span class="o">::</span><span class="ne">array</span><span class="p">)</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"all ints: "</span><span class="sa">sv</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">arr</span><span class="p">.</span><span class="n">is_homogeneous</span><span class="p">(</span><span class="ns">toml</span><span class="o">::</span><span class="ut">node_type</span><span class="o">::</span><span class="ne">integer</span><span class="p">)</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">homogeneous: true</span>
|
|
<span class="go">all floats: false</span>
|
|
<span class="go">all arrays: false</span>
|
|
<span class="go">all ints: true</span></pre><aside class="m-note m-default"><h4>Remark</h4><p>Always returns <code>false</code> for empty tables and arrays.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="ae4e986f9fdb23090f9a0b3716a63e8bb"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">bool toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ae4e986f9fdb23090f9a0b3716a63e8bb">is_homogeneous</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="namespacetoml.html#abac3e84bbf1f2c90717fca107055f48d">node_<wbr/>type</a> ntype,
|
|
<a class="m-doc" href="classtoml_1_1node.html">node</a>*& first_nonmatch) <span class="m-label m-warning">final</span> <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Checks if a node contains values/elements of only one type.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">ntype</td>
|
|
<td>A TOML node type.<br/><strong><em><a class="m-doc" href="namespacetoml.html#abac3e84bbf1f2c90717fca107055f48da334c4a4c42fdb79d7ebc3e73b517e6f8">toml::<wbr/>node_type::<wbr/>none</a>:</em></strong> "is every element the same type?" <strong><em>Anything else:</em></strong> "is every element one of these?"</td>
|
|
</tr>
|
|
<tr>
|
|
<td>first_nonmatch</td>
|
|
<td>Reference to a pointer in which the address of the first non-matching element will be stored if the return value is false.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>True if the node was homogeneous.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">cfg</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="n">parse</span><span class="p">(</span><span class="s">"arr = [ 1, 2, 3, 4.0 ]"</span><span class="p">);</span>
|
|
<span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="o">&</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">*</span><span class="n">cfg</span><span class="p">[</span><span class="s">"arr"</span><span class="p">].</span><span class="n">as_array</span><span class="p">();</span>
|
|
|
|
<span class="ns">toml</span><span class="o">::</span><span class="ut">node</span><span class="o">*</span><span class="w"> </span><span class="n">nonmatch</span><span class="p">{};</span>
|
|
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">arr</span><span class="p">.</span><span class="n">is_homogeneous</span><span class="p">(</span><span class="ns">toml</span><span class="o">::</span><span class="ut">node_type</span><span class="o">::</span><span class="ne">integer</span><span class="p">,</span><span class="w"> </span><span class="n">nonmatch</span><span class="p">))</span>
|
|
<span class="w"> </span><span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"array was homogeneous"</span><span class="sa">sv</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
<span class="k">else</span>
|
|
<span class="w"> </span><span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"array was not homogeneous!</span><span class="se">\n</span><span class="s">"</span>
|
|
<span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"first non-match was a "</span><span class="sa">sv</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">nonmatch</span><span class="o">-></span><span class="n">type</span><span class="p">()</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">" at "</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">nonmatch</span><span class="o">-></span><span class="n">source</span><span class="p">()</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">array was not homogeneous!</span>
|
|
<span class="go">first non-match was a floating-point at line 1, column 18</span></pre><aside class="m-note m-default"><h4>Remark</h4><p>Always returns <code>false</code> for empty tables and arrays.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a442d80f39922d05c46b4a7d9a5455585"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1node.html">node</a>* toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a442d80f39922d05c46b4a7d9a5455585">get</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> index) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets a pointer to the element at a specific index.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">index</td>
|
|
<td>The element's index.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A pointer to the element at the specified index if one existed, or nullptr.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">99</span><span class="p">,</span><span class="w"> </span><span class="s">"bottles of beer on the wall"</span><span class="w"> </span><span class="p">};</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"element [0] exists: "</span><span class="sa">sv</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="o">!!</span><span class="n">arr</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"element [1] exists: "</span><span class="sa">sv</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="o">!!</span><span class="n">arr</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
<span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"element [2] exists: "</span><span class="sa">sv</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="o">!!</span><span class="n">arr</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ns">toml</span><span class="o">::</span><span class="ut">node</span><span class="o">*</span><span class="w"> </span><span class="n">val</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">arr</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="mi">0</span><span class="p">))</span>
|
|
<span class="w"> </span><span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"element [0] is an "</span><span class="sa">sv</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">val</span><span class="o">-></span><span class="n">type</span><span class="p">()</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">element [0] exists: true</span>
|
|
<span class="go">element [1] exists: true</span>
|
|
<span class="go">element [2] exists: false</span>
|
|
<span class="go">element [0] is an integer</span></pre>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a0fb727f90506419f2e950b5d0e5160a9"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">const <a class="m-doc" href="classtoml_1_1node.html">node</a>* toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a0fb727f90506419f2e950b5d0e5160a9">get</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> index) const <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets a pointer to the element at a specific index (const overload).</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">index</td>
|
|
<td>The element's index.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A pointer to the element at the specified index if one existed, or nullptr.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a7ab30b16bb727e0595d0bd4adfcd9455"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ElemType>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper">impl::wrap_node<ElemType>* toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a7ab30b16bb727e0595d0bd4adfcd9455">get_as</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> index) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets a pointer to the element at a specific index if it is a particular type.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Template parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">ElemType</td>
|
|
<td><a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>, <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>, or a native TOML value type</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>index</td>
|
|
<td>The element's index.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A pointer to the selected element if it existed and was of the specified type, or nullptr.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span><span class="w"> </span><span class="n">arr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ns">toml</span><span class="o">::</span><span class="ut">array</span><span class="p">{</span><span class="w"> </span><span class="mi">42</span><span class="p">,</span><span class="w"> </span><span class="s">"is the meaning of life, apparently."</span><span class="sa">sv</span><span class="w"> </span><span class="p">};</span>
|
|
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ns">toml</span><span class="o">::</span><span class="ut">value</span><span class="o"><</span><span class="ut"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">int64_t</a></span><span class="o">>*</span><span class="w"> </span><span class="n">val</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">arr</span><span class="p">.</span><span class="n">get_as</span><span class="o"><</span><span class="ut"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/integer" target="_blank">int64_t</a></span><span class="o">></span><span class="p">(</span><span class="mi">0</span><span class="p">))</span>
|
|
<span class="w"> </span><span class="ns">std</span><span class="o">::</span><span class="ut">cout</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"element [0] is an integer with value "</span><span class="sa">sv</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="o">*</span><span class="n">val</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span></pre><pre class="m-console"><span class="go">element [0] is an integer with value 42</span></pre>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a17dc014c1c5e64dd9d4f118ddc066ed8"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ElemType>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper">const impl::wrap_node<ElemType>* toml::<wbr/>array::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a17dc014c1c5e64dd9d4f118ddc066ed8">get_as</a>(</span><span class="m-doc-wrap"><a class="m-doc poxy-injected poxy-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> index) const <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets a pointer to the element at a specific index if it is a particular type (const overload).</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Template parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">ElemType</td>
|
|
<td><a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>, <a class="m-doc" href="classtoml_1_1array.html">toml::<wbr/>array</a>, or a native TOML value type</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>index</td>
|
|
<td>The element's index.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A pointer to the selected element if it existed and was of the specified type, or nullptr.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="ada82b30641e7546cfe89ece1db7436cc"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html" target="_blank">std::<wbr/>ostream</a>& </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ada82b30641e7546cfe89ece1db7436cc">operator<<</a>(</span><span class="m-doc-wrap"><a class="m-doc-external poxy-external" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html" target="_blank">std::<wbr/>ostream</a>& lhs,
|
|
const <a class="m-doc" href="classtoml_1_1array.html">array</a>& rhs)</span></span>
|
|
</h3>
|
|
<p>Prints the array out to a stream as formatted TOML.</p>
|
|
<aside class="m-block m-special"><h4>Conditional availability </h4><p>This operator is only available when <a class="m-doc" href="group__configuration.html#ga9fc77582d9de77f59d2ddc9ae1f748ca">TOML_<wbr/>ENABLE_<wbr/>FORMATTERS</a> is enabled.</p></aside>
|
|
</div></section>
|
|
</section>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</article></main>
|
|
<div class="m-doc-search" id="search">
|
|
<a href="#!" onclick="return hideSearch()"></a>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-m-8 m-push-m-2">
|
|
<div class="m-doc-search-header m-text m-small">
|
|
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
|
<div id="search-symbolcount">…</div>
|
|
</div>
|
|
<div class="m-doc-search-content">
|
|
<form>
|
|
<input autocomplete="off" autofocus="autofocus" disabled="disabled" id="search-input" name="q" placeholder="Loading …" spellcheck="false" type="search"/>
|
|
</form>
|
|
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
|
<div class="m-text m-dim m-text-center" id="search-help">
|
|
<p class="m-noindent">Search for symbols, directories, files, pages or
|
|
modules. You can omit any prefix from the symbol or file path; adding a
|
|
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
|
directory.</p>
|
|
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
|
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
|
<span class="m-label m-dim">Enter</span> to go.
|
|
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
|
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
|
</div>
|
|
<div class="m-text m-warning m-text-center" id="search-notfound">Sorry, nothing was found.</div>
|
|
<ul id="search-results"></ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script src="search-v2.js"></script>
|
|
<script async="async" src="searchdata-v2.js"></script>
|
|
<footer><nav>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
|
|
<a class="poxy-external" href="https://github.com/marzer/tomlplusplus/" target="_blank">Github</a>
|
|
• <a class="poxy-external" href="https://github.com/marzer/tomlplusplus/issues" target="_blank">Report an issue</a>
|
|
• <a href="md_poxy_changelog.html">Changelog</a>
|
|
• <a class="poxy-external" href="https://github.com/marzer/tomlplusplus/blob/master/LICENSE" target="_blank">License</a>
|
|
• <a download="" href="toml++.tagfile.xml" target="_blank" type="text/xml">Doxygen tagfile</a>
|
|
<br/><br/>
|
|
Site generated using <a class="poxy-external" href="https://github.com/marzer/poxy/" target="_blank">Poxy</a>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></footer>
|
|
|
|
|
|
</body></html> |