mirror of
https://github.com/marzer/tomlplusplus.git
synced 2026-02-21 15:42:12 +00:00
1412 lines
117 KiB
HTML
1412 lines
117 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><head>
|
|
<meta charset="utf-8"/>
|
|
<title>toml::table class | toml++ TOML
|
|
for
|
|
modern
|
|
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="tomlplusplus.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="gbtcNgKlNiPSMKkYMw4zWFVWGPH_oU93m9n_-nb4qK8" name="google-site-verification"/>
|
|
<meta content="Header-only
|
|
TOML
|
|
config
|
|
file
|
|
parser
|
|
and
|
|
serializer
|
|
for
|
|
modern
|
|
C++." name="description"/>
|
|
<script src="tomlplusplus.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
|
|
modern
|
|
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>
|
|
</ol>
|
|
<ol class="m-col-t-6 m-col-m-none" start="2">
|
|
<li><a href="annotated.html">Classes</a></li>
|
|
<li><a class="github tpp-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>table <span class="m-thin">class</span> <span class="m-label m-flat m-warning">final</span>
|
|
</h1>
|
|
<p>A TOML table.</p>
|
|
<div class="m-block m-default">
|
|
<h3>Contents</h3>
|
|
<ul>
|
|
<li>
|
|
Reference
|
|
<ul>
|
|
<li><a href="#base-classes">Base classes</a></li>
|
|
<li><a href="#pub-types">Public types</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="#friends">Friends</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<aside class="m-note m-default"><h4>Remark</h4><p>The interface of this type is modeled after <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/container/map" target="_blank">std::map</a>, with some additional considerations made for the heterogeneous nature of a TOML table, and for the removal of some cruft (the public interface of <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/container/map" target="_blank">std::map</a> is, simply, <em>a hot mess</em>).</p></aside>
|
|
<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="pub-types">
|
|
<h2><a href="#pub-types">Public types</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="a5a6ce59c3fe438ac94eadaa8a2b17957">
|
|
using <a class="m-doc-self" href="#a5a6ce59c3fe438ac94eadaa8a2b17957">const_iterator</a> = <a class="m-doc" href="namespacetoml.html#adeb2aa84bcd2bcb46e2cdfaa5dd6572f">const_<wbr/>table_<wbr/>iterator</a>
|
|
</dt>
|
|
<dd>A <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/named_req/BidirectionalIterator" target="_blank">BidirectionalIterator</a> for iterating over const key-value pairs in a <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>.</dd>
|
|
<dt id="aeecd89b0c0b321a9aff276ff1470f1d7">
|
|
using <a class="m-doc-self" href="#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> = <a class="m-doc" href="namespacetoml.html#a57894617837065610e5746a3204fa8e9">table_<wbr/>iterator</a>
|
|
</dt>
|
|
<dd>A <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/named_req/BidirectionalIterator" target="_blank">BidirectionalIterator</a> for iterating over key-value pairs in a <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="typeless-methods">
|
|
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="a823f0d3385d2d8d8320a72f78c677a35">
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a823f0d3385d2d8d8320a72f78c677a35">table</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="a94c0bf5a412f0bed2ad23914d9685b2f">
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a94c0bf5a412f0bed2ad23914d9685b2f">table</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1table.html">table</a>&) <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Copy constructor.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<<a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> N></div>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="#a58a5d740a7b210b1942915f98fe9d8fe">table</a>(</span><span class="m-doc-wrap">impl::table_init_pair( && arr)[N]) <span class="m-label m-flat m-info">explicit</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Constructs a table with one or more initial key-value pairs.</dd>
|
|
<dt id="ab47a76ab242afa13f1a74e5e2bcded44">
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ab47a76ab242afa13f1a74e5e2bcded44">table</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1table.html">table</a>&& other) <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Move constructor.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="pub-methods">
|
|
<h2><a href="#pub-methods">Public functions</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="aafd874c7b06b7f0f535e713b2640fe96">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#aafd874c7b06b7f0f535e713b2640fe96">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">override</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns a pointer to the node as a <a class="m-doc" href="classtoml_1_1table.html">toml::<wbr/>table</a>, if it is one.</dd>
|
|
<dt id="a3352f9954e03087b6f596ae23283bd3c">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a3352f9954e03087b6f596ae23283bd3c">begin</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc" href="classtoml_1_1table.html#a5a6ce59c3fe438ac94eadaa8a2b17957">const_<wbr/>iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns an iterator to the first key-value pair.</dd>
|
|
<dt id="a334f050427eb20c8530254f4cd6dddf3">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a334f050427eb20c8530254f4cd6dddf3">begin</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns an iterator to the first key-value pair.</dd>
|
|
<dt id="a15a5f8bd6d194fcbe925a24e5b73b1fb">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a15a5f8bd6d194fcbe925a24e5b73b1fb">cbegin</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc" href="classtoml_1_1table.html#a5a6ce59c3fe438ac94eadaa8a2b17957">const_<wbr/>iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns an iterator to the first key-value pair.</dd>
|
|
<dt id="a311451209f990931ea25828c6091714f">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a311451209f990931ea25828c6091714f">cend</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc" href="classtoml_1_1table.html#a5a6ce59c3fe438ac94eadaa8a2b17957">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 key-value pair.</dd>
|
|
<dt id="aa710f85c588a1b00c3192d1553de4eef">
|
|
<span class="m-doc-wrap-bumper">void <a class="m-doc-self" href="#aa710f85c588a1b00c3192d1553de4eef">clear</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Removes all key-value pairs from the table.</dd>
|
|
<dt id="aacf6efa6e7865211f7a1283f79a88ee0">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#aacf6efa6e7865211f7a1283f79a88ee0">contains</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) const -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns true if the table contains a node at the given key.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a2449e053ad373e82d2500226bf084cb9">contains</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) const -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns true if the table contains a node at the given key.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ValueType, typename KeyType, typename... ValueArgs></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a04815da57fe75169ceb1c20946faac6b">emplace</a>(</span><span class="m-doc-wrap">KeyType&& key,
|
|
ValueArgs && ... args) -> <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/utility/pair" target="_blank">std::pair</a><<a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a>, bool> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Emplaces a new value at a specific key if one did not already exist.</dd>
|
|
<dt id="a554f495f6f2ebc993be1bd0379447051">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a554f495f6f2ebc993be1bd0379447051">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 table is empty.</dd>
|
|
<dt id="a40c72e81de1da66b7083cad11442cb05">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a40c72e81de1da66b7083cad11442cb05">end</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc" href="classtoml_1_1table.html#a5a6ce59c3fe438ac94eadaa8a2b17957">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 key-value pair.</dd>
|
|
<dt id="a96da67654c5ca131cfec2e3c07aa2730">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a96da67654c5ca131cfec2e3c07aa2730">end</a>(</span><span class="m-doc-wrap">) -> <a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Returns an iterator to one-past-the-last key-value pair.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a020e8f71bec1fbff52260a5a1e0cb12e">erase</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1table.html#a5a6ce59c3fe438ac94eadaa8a2b17957">const_<wbr/>iterator</a> first,
|
|
<a class="m-doc" href="classtoml_1_1table.html#a5a6ce59c3fe438ac94eadaa8a2b17957">const_<wbr/>iterator</a> last) -> <a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Removes the key-value pairs in the range [first, last) from the table.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a4dafb4ae116d92add973e5f27f880a9d">erase</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1table.html#a5a6ce59c3fe438ac94eadaa8a2b17957">const_<wbr/>iterator</a> pos) -> <a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Removes the specified key-value pair from the table (const iterator overload).</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a1a90984876ccdd03aaa9e0f9801a839f">erase</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> pos) -> <a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Removes the specified key-value pair from the table.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#ad9d90151f332b24a0c747fa33ebb81e1">erase</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Removes the value with the given key from the table.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a53151a06151fbd78887e027e95c3f788">erase</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Removes the value with the given key from the table.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a65a894481bab5dd2bd00690931ed2692">find</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) const -> <a class="m-doc" href="classtoml_1_1table.html#a5a6ce59c3fe438ac94eadaa8a2b17957">const_<wbr/>iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets an iterator to the node at a specific key (const overload)</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a087ecb9d9fd4562d79f83341f0c643c0">find</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) -> <a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets an iterator to the node at a specific key.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#ab55a7ed5c436a045c69a1f1adcb07b5c">find</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) const -> <a class="m-doc" href="classtoml_1_1table.html#a5a6ce59c3fe438ac94eadaa8a2b17957">const_<wbr/>iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets an iterator to the node at a specific key (const overload).</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a5b6b0b84c1d2fe24b7b370f989cbd98e">find</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) -> <a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets an iterator to the node at a specific key.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a43afae4f760f715c69b0b8aa0a7ef071">get</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) 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 the node at a specific key (const overload).</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#ae6811ea7c692ac71880693e225c66aed">get</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) -> <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 the node at a specific key.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a615c9124ee853eb6a7544c0ab3b9911f">get</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) 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 the node at a specific key (const overload).</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#aa67b393855cbd706ce89d5a09f062002">get</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) -> <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 the node at a specific key.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ValueType></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a180f46103dda744bf75eeadb32659b7c">get_as</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) const -> const impl::wrap_node<ValueType>* <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets the node at a specific key if it is a particular type (const overload).</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ValueType></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a933f4a709d7bb5f51a756e571f6166f9">get_as</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) -> impl::wrap_node<ValueType>* <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets the node at a specific key if it is a particular type.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ValueType></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#ad734dfa38c76cf282235befd30354c90">get_as</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) const -> const impl::wrap_node<ValueType>* <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets the node at a specific key if it is a particular type (const overload).</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename ValueType></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#ade6422b39babbf9b3e4b87cd985f0d14">get_as</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) -> impl::wrap_node<ValueType>* <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Gets the node at a specific key if it is a particular type.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename Iter, typename = <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/types/enable_if" target="_blank">std::enable_if_t</a><<span class="tpp-injected tpp-enable-if"><a href="#" onclick="ToggleEnableIf(this);return false;" title="!std::is_convertible_v<Iter, std::string_view> && !impl::is_wide_string<Iter">...</a><span>!std::is_convertible_v<Iter, std::string_view> && !impl::is_wide_string<Iter</span></span>> >></div>
|
|
<span class="m-doc-wrap-bumper">void <a class="m-doc" href="#acefff2dfe1efb072c9062b8f60146cd9">insert</a>(</span><span class="m-doc-wrap">Iter first,
|
|
Iter last) <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Inserts a series of key-value pairs into the table.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename KeyType, typename ValueType, typename = <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/types/enable_if" target="_blank">std::enable_if_t</a><<span class="tpp-injected tpp-enable-if"><a href="#" onclick="ToggleEnableIf(this);return false;" title="std::is_convertible_v<KeyType && , std::string_view> || impl::is_wide_string<KeyType">...</a><span>std::is_convertible_v<KeyType && , std::string_view> || impl::is_wide_string<KeyType</span></span>> >></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#aa757797646986f2f2cce0fa84221963e">insert</a>(</span><span class="m-doc-wrap">KeyType&& key,
|
|
ValueType&& val) -> <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/utility/pair" target="_blank">std::pair</a><<a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a>, bool> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Inserts a new value at a specific key if one did not already exist.</dd>
|
|
<dt>
|
|
<div class="m-doc-template">template<typename KeyType, typename ValueType></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#acb97b09eb0b36ea708178678f15d0614">insert_or_assign</a>(</span><span class="m-doc-wrap">KeyType&& key,
|
|
ValueType&& val) -> <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/utility/pair" target="_blank">std::pair</a><<a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a>, bool> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Inserts or assigns a value at a specific key.</dd>
|
|
<dt id="a8d24e995e5cfab4933c82ccd95dd6fa3">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a8d24e995e5cfab4933c82ccd95dd6fa3">is_array</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">override</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Always returns <code>false</code> for table nodes.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a53be1b93aa90608ed378323df835a2f3">is_inline</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 this table is an inline table.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">void <a class="m-doc" href="#a8e797a683ff2bacd14d7e7461ecd2780">is_inline</a>(</span><span class="m-doc-wrap">bool val) <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Sets whether this table is a TOML inline table.</dd>
|
|
<dt id="ad2f9333f6aeb634f4ddbec38493da7c2">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#ad2f9333f6aeb634f4ddbec38493da7c2">is_table</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">override</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Always returns <code>true</code> for table nodes.</dd>
|
|
<dt id="af137c1e4cf632015709d6a566cc74edc">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#af137c1e4cf632015709d6a566cc74edc">is_value</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-warning">override</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Always returns <code>false</code> for table nodes.</dd>
|
|
<dt id="a54571ed4637b4164cb559135807d00c0">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a54571ed4637b4164cb559135807d00c0">operator=</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1table.html">table</a>&) -> <a class="m-doc" href="classtoml_1_1table.html">table</a>& <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Copy-assignment operator.</dd>
|
|
<dt id="a5c5fd0e11db828ab264eccc96dfdd619">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#a5c5fd0e11db828ab264eccc96dfdd619">operator=</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1table.html">table</a>&& rhs) -> <a class="m-doc" href="classtoml_1_1table.html">table</a>& <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Move-assignment operator.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a9b13a19ddfcd2f76685f57587d28701c">operator[]</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) 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>Gets a <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a> for the selected key-value pair (const overload).</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a6d8386049f630c8551597a2180479c7c">operator[]</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) -> <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>Gets a <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a> for the selected key-value pair.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a404ae83ed52c7b8ce294d3d4925c8a16">operator[]</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) 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>Gets a <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a> for the selected key-value pair (const overload).</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#a06fd3d9032b031b0363818939cd5cf38">operator[]</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) -> <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>Gets a <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a> for the selected key-value pair.</dd>
|
|
<dt id="ad7c4105854cc817bf6e781fa7fb1b6d6">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#ad7c4105854cc817bf6e781fa7fb1b6d6">size</a>(</span><span class="m-doc-wrap">) const -> <a class="m-doc tpp-injected tpp-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 key-value pairs in the table.</dd>
|
|
<dt id="afe589750b98c702710d643a81ed6b9af">
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#afe589750b98c702710d643a81ed6b9af">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">override</span> <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Always returns <code><a class="m-doc" href="namespacetoml.html#abac3e84bbf1f2c90717fca107055f48daaab9e1de16f38176f86d7a92ba337a8d">node_type::<wbr/>table</a></code> for table nodes.</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="#abdeb5d9d9fc23c031c78e544c6196ea6">operator!=</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1table.html">table</a>& lhs,
|
|
const <a class="m-doc" href="classtoml_1_1table.html">table</a>& rhs) -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Inequality operator.</dd>
|
|
<dt id="ab34ff6b624f5f39fa8002f3d6e539eca">
|
|
<div class="m-doc-template">template<typename Char></div>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc-self" href="#ab34ff6b624f5f39fa8002f3d6e539eca">operator<<</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/io/basic_ostream" target="_blank">std::basic_ostream</a><Char>&,
|
|
const <a class="m-doc" href="classtoml_1_1table.html">table</a>&) -> <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/io/basic_ostream" target="_blank">std::basic_ostream</a><Char>&</span>
|
|
</dt>
|
|
<dd>Prints the table out to a stream as formatted TOML.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a class="m-doc" href="#af8ebaed8105e5de2098992764f2d534a">operator==</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1table.html">table</a>& lhs,
|
|
const <a class="m-doc" href="classtoml_1_1table.html">table</a>& rhs) -> bool <span class="m-label m-flat m-success">noexcept</span></span>
|
|
</dt>
|
|
<dd>Equality operator.</dd>
|
|
</dl>
|
|
</section>
|
|
<section>
|
|
<h2>Function documentation</h2>
|
|
<section class="m-doc-details" id="a58a5d740a7b210b1942915f98fe9d8fe"><div>
|
|
<h3>
|
|
<div class="m-doc-template"> template<<a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/types/size_t" target="_blank">size_t</a> N>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper"> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a58a5d740a7b210b1942915f98fe9d8fe">table</a>(</span><span class="m-doc-wrap">impl::table_init_pair( && arr)[N]) <span class="m-label m-info">explicit</span> <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Constructs a table with one or more initial key-value pairs.</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%">N</td>
|
|
<td>Number of key-value pairs used to initialize the table.</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>arr</td>
|
|
<td>An array of key-value pairs used to initialize the table.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="ns">toml::</span><span class="ut">table</span><span class="p">{{</span> <span class="c1">// double braces required :( - see remark</span>
|
|
<span class="p">{</span> <span class="s">"foo"</span><span class="p">,</span> <span class="mi">1</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"bar"</span><span class="p">,</span> <span class="mf">2.0</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"kek"</span><span class="p">,</span> <span class="s">"three"</span> <span class="p">}</span>
|
|
<span class="p">}};</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</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">{ foo = 1, bar = 2.0, kek = "three" }</span></pre><aside class="m-note m-default"><h4>Remark</h4><p>C++ <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/utility/initializer_list" target="_blank">std::initializer_lists</a> represent their member elements as const even if the list's value type is non-const. This is great for compiler writers, I guess, but pretty annoying for me since TOML key-value pairs are polymorphic (and thus move-only). This means that for the human-friendly braced init list syntax to work I can't use <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/utility/initializer_list" target="_blank">std::initializer_list</a> and must instead invent an annoying proxy type, which means an extra level of nesting.<br/><br/>See <a class="tpp-external" href="https://en.cppreference.com/w/cpp/utility/initializer_list" target="_blank">https://en.cppreference.com/w/cpp/utility/initializer_<wbr/>list</a> if you'd like to learn more about this.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a2449e053ad373e82d2500226bf084cb9"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">bool toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a2449e053ad373e82d2500226bf084cb9">contains</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) const <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Returns true if the table contains a node at the given key.</p>
|
|
<aside class="m-note m-warning"><h4>Attention</h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga0785b375499ea976c627d775f8fc747b">TOML_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a04815da57fe75169ceb1c20946faac6b"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ValueType, typename KeyType, typename... ValueArgs>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/utility/pair" target="_blank">std::pair</a><<a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a>, bool> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a04815da57fe75169ceb1c20946faac6b">emplace</a>(</span><span class="m-doc-wrap">KeyType&& key,
|
|
ValueArgs && ... args) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Emplaces a new value at a specific key if one did not already exist.</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%">ValueType</td>
|
|
<td>One of the TOML node or value types.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>KeyType</td>
|
|
<td><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string" target="_blank">std::string</a> (or a type convertible to it).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ValueArgs</td>
|
|
<td>Value constructor argument types.</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>key</td>
|
|
<td>The key at which to emplace the new value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>args</td>
|
|
<td>Arguments to forward to the value's constructor.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td><p>A <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/utility/pair" target="_blank">std::pair</a> containing:</p><ul><li>An iterator to the emplacement position (or the position of the value that prevented emplacement)</li><li>A boolean indicating if the emplacement was successful.<br/></li></ul></td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="ns">toml::</span><span class="ut">table</span><span class="p">{{</span>
|
|
<span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="mi">1</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"b"</span><span class="p">,</span> <span class="mi">2</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"c"</span><span class="p">,</span> <span class="mi">3</span> <span class="p">}</span>
|
|
<span class="p">}};</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="k">for</span> <span class="p">(</span><span class="k">auto</span> <span class="nl">k</span> <span class="p">:</span> <span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="s">"d"</span> <span class="p">})</span>
|
|
<span class="p">{</span>
|
|
<span class="c1">// add a string using <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string" target="_blank">std::string</a>'s substring constructor</span>
|
|
<span class="k">auto</span> <span class="n">result</span> <span class="o">=</span> <span class="n">tbl</span><span class="p">.</span><span class="n">emplace</span><span class="o"><</span><span class="ns">std::</span><span class="ut">string</span><span class="o">></span><span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="s">"this is not a drill"</span><span class="sa">sv</span><span class="p">,</span> <span class="mi">14</span><span class="p">,</span> <span class="mi">5</span><span class="p">);</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="s">"emplaced with key '"</span><span class="sa">sv</span> <span class="o"><<</span> <span class="n">k</span> <span class="o"><<</span> <span class="s">"': "</span><span class="sa">sv</span> <span class="o"><<</span> <span class="n">result</span><span class="p">.</span><span class="n">second</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</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">{ a = 1, b = 2, c = 3 }</span>
|
|
<span class="go">emplaced with key 'a': false</span>
|
|
<span class="go">emplaced with key 'd': true</span>
|
|
<span class="go">{ a = 1, b = 2, c = 3, d = "drill" }</span></pre><aside class="m-note m-default"><h4>Remark</h4><p>There is no difference between <a class="m-doc" href="classtoml_1_1table.html#aa757797646986f2f2cce0fa84221963e">insert()</a> and <a class="m-doc" href="classtoml_1_1table.html#a04815da57fe75169ceb1c20946faac6b">emplace()</a> for trivial value types (floats, ints, bools).</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a020e8f71bec1fbff52260a5a1e0cb12e"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a020e8f71bec1fbff52260a5a1e0cb12e">erase</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1table.html#a5a6ce59c3fe438ac94eadaa8a2b17957">const_<wbr/>iterator</a> first,
|
|
<a class="m-doc" href="classtoml_1_1table.html#a5a6ce59c3fe438ac94eadaa8a2b17957">const_<wbr/>iterator</a> last) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Removes the key-value pairs in the range [first, last) from the table.</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 key-value pair being erased.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>last</td>
|
|
<td>Iterator to the one-past-the-last key-value pair being erased.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>Iterator to the first key-value pair immediately following the last removed key-value pair.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="ns">toml::</span><span class="ut">table</span><span class="p">{{</span>
|
|
<span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="mi">1</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"b"</span><span class="p">,</span> <span class="s">"bad"</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"c"</span><span class="p">,</span> <span class="s">"karma"</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"d"</span><span class="p">,</span> <span class="mi">2</span> <span class="p">}</span>
|
|
<span class="p">}};</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="n">tbl</span><span class="p">.</span><span class="n">erase</span><span class="p">(</span><span class="n">tbl</span><span class="p">.</span><span class="n">cbegin</span><span class="p">()</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="n">tbl</span><span class="p">.</span><span class="n">cbegin</span><span class="p">()</span> <span class="o">+</span> <span class="mi">3</span><span class="p">);</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</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">{ a = 1, b = "bad", c = "karma", d = 2 }</span>
|
|
<span class="go">{ a = 1, d = 2 }</span></pre>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a4dafb4ae116d92add973e5f27f880a9d"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a4dafb4ae116d92add973e5f27f880a9d">erase</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1table.html#a5a6ce59c3fe438ac94eadaa8a2b17957">const_<wbr/>iterator</a> pos) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Removes the specified key-value pair from the table (const iterator 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%">pos</td>
|
|
<td>Iterator to the key-value pair being erased.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>Iterator to the first key-value pair immediately following the removed key-value pair.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="ns">toml::</span><span class="ut">table</span><span class="p">{{</span>
|
|
<span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="mi">1</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"b"</span><span class="p">,</span> <span class="mi">2</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"c"</span><span class="p">,</span> <span class="mi">3</span> <span class="p">}</span>
|
|
<span class="p">}};</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="n">tbl</span><span class="p">.</span><span class="n">erase</span><span class="p">(</span><span class="n">tbl</span><span class="p">.</span><span class="n">cbegin</span><span class="p">()</span> <span class="o">+</span> <span class="mi">1</span><span class="p">);</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</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">{ a = 1, b = 2, c = 3 }</span>
|
|
<span class="go">{ a = 1, c = 3 }</span></pre>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a1a90984876ccdd03aaa9e0f9801a839f"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a1a90984876ccdd03aaa9e0f9801a839f">erase</a>(</span><span class="m-doc-wrap"><a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> pos) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Removes the specified key-value pair from the table.</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 key-value pair being erased.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>Iterator to the first key-value pair immediately following the removed key-value pair.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="ns">toml::</span><span class="ut">table</span><span class="p">{{</span>
|
|
<span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="mi">1</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"b"</span><span class="p">,</span> <span class="mi">2</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"c"</span><span class="p">,</span> <span class="mi">3</span> <span class="p">}</span>
|
|
<span class="p">}};</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="n">tbl</span><span class="p">.</span><span class="n">erase</span><span class="p">(</span><span class="n">tbl</span><span class="p">.</span><span class="n">begin</span><span class="p">()</span> <span class="o">+</span> <span class="mi">1</span><span class="p">);</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</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">{ a = 1, b = 2, c = 3 }</span>
|
|
<span class="go">{ a = 1, c = 3 }</span></pre>
|
|
</div></section>
|
|
<section class="m-doc-details" id="ad9d90151f332b24a0c747fa33ebb81e1"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">bool toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ad9d90151f332b24a0c747fa33ebb81e1">erase</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Removes the value with the given key from the table.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">key</td>
|
|
<td>Key to erase.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>True if any values with matching keys were found and erased.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="ns">toml::</span><span class="ut">table</span><span class="p">{{</span>
|
|
<span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="mi">1</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"b"</span><span class="p">,</span> <span class="mi">2</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"c"</span><span class="p">,</span> <span class="mi">3</span> <span class="p">}</span>
|
|
<span class="p">}};</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</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="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span><span class="p">.</span><span class="n">erase</span><span class="p">(</span><span class="s">"b"</span><span class="p">)</span> <span class="o"><<</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="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span><span class="p">.</span><span class="n">erase</span><span class="p">(</span><span class="s">"not an existing key"</span><span class="p">)</span> <span class="o"><<</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="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</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">{ a = 1, b = 2, c = 3 }</span>
|
|
<span class="go">true</span>
|
|
<span class="go">false</span>
|
|
<span class="go">{ a = 1, c = 3 }</span></pre>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a53151a06151fbd78887e027e95c3f788"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">bool toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a53151a06151fbd78887e027e95c3f788">erase</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Removes the value with the given key from the table.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">key</td>
|
|
<td>Key to erase.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>True if any values with matching keys were found and erased.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<aside class="m-note m-warning"><h4>Attention</h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga0785b375499ea976c627d775f8fc747b">TOML_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a65a894481bab5dd2bd00690931ed2692"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1table.html#a5a6ce59c3fe438ac94eadaa8a2b17957">const_<wbr/>iterator</a> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a65a894481bab5dd2bd00690931ed2692">find</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) const <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets an iterator to the node at a specific key (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%">key</td>
|
|
<td>The node's key.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A const iterator to the node at the specified key, or <a class="m-doc" href="classtoml_1_1table.html#a311451209f990931ea25828c6091714f">cend()</a>.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a087ecb9d9fd4562d79f83341f0c643c0"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a087ecb9d9fd4562d79f83341f0c643c0">find</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets an iterator to the node at a specific key.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">key</td>
|
|
<td>The node's key.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>An iterator to the node at the specified key, or <a class="m-doc" href="classtoml_1_1table.html#a96da67654c5ca131cfec2e3c07aa2730">end()</a>.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="ab55a7ed5c436a045c69a1f1adcb07b5c"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1table.html#a5a6ce59c3fe438ac94eadaa8a2b17957">const_<wbr/>iterator</a> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ab55a7ed5c436a045c69a1f1adcb07b5c">find</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) const <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets an iterator to the node at a specific key (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%">key</td>
|
|
<td>The node's key.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A const iterator to the node at the specified key, or <a class="m-doc" href="classtoml_1_1table.html#a311451209f990931ea25828c6091714f">cend()</a>.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<aside class="m-note m-warning"><h4>Attention</h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga0785b375499ea976c627d775f8fc747b">TOML_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a5b6b0b84c1d2fe24b7b370f989cbd98e"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a5b6b0b84c1d2fe24b7b370f989cbd98e">find</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets an iterator to the node at a specific key.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">key</td>
|
|
<td>The node's key.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>An iterator to the node at the specified key, or <a class="m-doc" href="classtoml_1_1table.html#a96da67654c5ca131cfec2e3c07aa2730">end()</a>.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<aside class="m-note m-warning"><h4>Attention</h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga0785b375499ea976c627d775f8fc747b">TOML_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a43afae4f760f715c69b0b8aa0a7ef071"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">const <a class="m-doc" href="classtoml_1_1node.html">node</a>* toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a43afae4f760f715c69b0b8aa0a7ef071">get</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) const <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets the node at a specific key (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%">key</td>
|
|
<td>The node's key.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A pointer to the node at the specified key, or nullptr.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="ae6811ea7c692ac71880693e225c66aed"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1node.html">node</a>* toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ae6811ea7c692ac71880693e225c66aed">get</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets the node at a specific key.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">key</td>
|
|
<td>The node's key.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A pointer to the node at the specified key, or nullptr.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="ns">toml::</span><span class="ut">table</span><span class="p">{{</span>
|
|
<span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="mi">42</span><span class="p">,</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"b"</span><span class="p">,</span> <span class="s">"is the meaning of life, apparently."</span> <span class="p">}</span>
|
|
<span class="p">}};</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="sa">R</span><span class="s">"</span><span class="dl">(</span><span class="s">node ["a"] exists: </span><span class="dl">)</span><span class="s">"</span><span class="sa">sv</span> <span class="o"><<</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="s">"a"</span><span class="p">)</span> <span class="o"><<</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="n">cout</span> <span class="o"><<</span> <span class="sa">R</span><span class="s">"</span><span class="dl">(</span><span class="s">node ["b"] exists: </span><span class="dl">)</span><span class="s">"</span><span class="sa">sv</span> <span class="o"><<</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="s">"b"</span><span class="p">)</span> <span class="o"><<</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="n">cout</span> <span class="o"><<</span> <span class="sa">R</span><span class="s">"</span><span class="dl">(</span><span class="s">node ["c"] exists: </span><span class="dl">)</span><span class="s">"</span><span class="sa">sv</span> <span class="o"><<</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="s">"c"</span><span class="p">)</span> <span class="o"><<</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="p">(</span><span class="k">auto</span> <span class="n">val</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="s">"a"</span><span class="p">))</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="sa">R</span><span class="s">"</span><span class="dl">(</span><span class="s">node ["a"] was an </span><span class="dl">)</span><span class="s">"</span><span class="sa">sv</span> <span class="o"><<</span> <span class="n">val</span><span class="o">-></span><span class="n">type</span><span class="p">()</span> <span class="o"><<</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">node ["a"] exists: true</span>
|
|
<span class="go">node ["b"] exists: true</span>
|
|
<span class="go">node ["c"] exists: false</span>
|
|
<span class="go">node ["a"] was an integer</span></pre>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a615c9124ee853eb6a7544c0ab3b9911f"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">const <a class="m-doc" href="classtoml_1_1node.html">node</a>* toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a615c9124ee853eb6a7544c0ab3b9911f">get</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) const <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets the node at a specific key (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%">key</td>
|
|
<td>The node's key.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A pointer to the node at the specified key, or nullptr.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<aside class="m-note m-warning"><h4>Attention</h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga0785b375499ea976c627d775f8fc747b">TOML_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="aa67b393855cbd706ce89d5a09f062002"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc" href="classtoml_1_1node.html">node</a>* toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#aa67b393855cbd706ce89d5a09f062002">get</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets the node at a specific key.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">key</td>
|
|
<td>The node's key.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A pointer to the node at the specified key, or nullptr.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<aside class="m-note m-warning"><h4>Attention</h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga0785b375499ea976c627d775f8fc747b">TOML_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a180f46103dda744bf75eeadb32659b7c"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ValueType>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper">const impl::wrap_node<ValueType>* toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a180f46103dda744bf75eeadb32659b7c">get_as</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) const <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets the node at a specific key 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%">ValueType</td>
|
|
<td>One of the TOML node or value types.</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>key</td>
|
|
<td>The node's key.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A pointer to the node at the specified key if it was of the given type, or nullptr.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a933f4a709d7bb5f51a756e571f6166f9"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ValueType>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper">impl::wrap_node<ValueType>* toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a933f4a709d7bb5f51a756e571f6166f9">get_as</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets the node at a specific key 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%">ValueType</td>
|
|
<td>One of the TOML node or value types.</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>key</td>
|
|
<td>The node's key.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A pointer to the node at the specified key if it was of the given type, or nullptr.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="ns">toml::</span><span class="ut">table</span><span class="p">{{</span>
|
|
<span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="mi">42</span><span class="p">,</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"b"</span><span class="p">,</span> <span class="s">"is the meaning of life, apparently."</span> <span class="p">}</span>
|
|
<span class="p">}};</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="k">auto</span> <span class="n">val</span> <span class="o">=</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 tpp-injected tpp-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="s">"a"</span><span class="p">))</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="sa">R</span><span class="s">"</span><span class="dl">(</span><span class="s">node ["a"] was an integer with value </span><span class="dl">)</span><span class="s">"</span><span class="sa">sv</span> <span class="o"><<</span> <span class="o">**</span><span class="n">val</span> <span class="o"><<</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">node ["a"] was an integer with value 42</span></pre>
|
|
</div></section>
|
|
<section class="m-doc-details" id="ad734dfa38c76cf282235befd30354c90"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ValueType>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper">const impl::wrap_node<ValueType>* toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ad734dfa38c76cf282235befd30354c90">get_as</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) const <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets the node at a specific key 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%">ValueType</td>
|
|
<td>One of the TOML node or value types.</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>key</td>
|
|
<td>The node's key.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A pointer to the node at the specified key if it was of the given type, or nullptr.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<aside class="m-note m-warning"><h4>Attention</h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga0785b375499ea976c627d775f8fc747b">TOML_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="ade6422b39babbf9b3e4b87cd985f0d14"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename ValueType>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper">impl::wrap_node<ValueType>* toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#ade6422b39babbf9b3e4b87cd985f0d14">get_as</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets the node at a specific key 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%">ValueType</td>
|
|
<td>One of the TOML node or value types.</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>key</td>
|
|
<td>The node's key.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A pointer to the node at the specified key if it was of the given type, or nullptr.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<aside class="m-note m-warning"><h4>Attention</h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga0785b375499ea976c627d775f8fc747b">TOML_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="acefff2dfe1efb072c9062b8f60146cd9"><div>
|
|
<h3>
|
|
<div class="m-doc-template"> template<typename Iter, typename = <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/types/enable_if" target="_blank">std::enable_if_t</a><<span class="tpp-injected tpp-enable-if"><a href="#" onclick="ToggleEnableIf(this);return false;" title="!std::is_convertible_v<Iter, std::string_view> && !impl::is_wide_string<Iter">...</a><span>!std::is_convertible_v<Iter, std::string_view> && !impl::is_wide_string<Iter</span></span>> >>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper">void toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#acefff2dfe1efb072c9062b8f60146cd9">insert</a>(</span><span class="m-doc-wrap">Iter first,
|
|
Iter last) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Inserts a series of key-value pairs into the table.</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 <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/named_req/InputIterator" target="_blank">InputIterator</a> to a collection of key-value pairs.</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>first</td>
|
|
<td>An iterator to the first value in the input collection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>last</td>
|
|
<td>An iterator to one-past-the-last value in the input collection.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<pre class="m-code"><p class="m-note m-success godbolt"><a class="tpp-external godbolt" href="https://godbolt.org/z/bzYcce" target="_blank">Try this code on Compiler Explorer</a></p><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="ns">toml::</span><span class="ut">table</span><span class="p">{{</span>
|
|
<span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="mi">1</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"b"</span><span class="p">,</span> <span class="mi">2</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"c"</span><span class="p">,</span> <span class="mi">3</span> <span class="p">}</span>
|
|
<span class="p">}};</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="k">auto</span> <span class="n">kvps</span> <span class="o">=</span> <span class="ns">std::</span><span class="ut">array</span><span class="o"><</span><span class="ns">std::</span><span class="ut">pair</span><span class="o"><</span><span class="ns">std::</span><span class="ut">string</span><span class="p">,</span> <span class="ut">int</span><span class="o">></span><span class="p">,</span> <span class="mi">2</span><span class="o">></span><span class="p">{{</span>
|
|
<span class="p">{</span> <span class="s">"d"</span><span class="p">,</span> <span class="mi">42</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="mi">43</span> <span class="p">}</span> <span class="c1">// won't be inserted, 'a' already exists</span>
|
|
<span class="p">}};</span>
|
|
<span class="n">tbl</span><span class="p">.</span><span class="n">insert</span><span class="p">(</span><span class="n">kvps</span><span class="p">.</span><span class="n">begin</span><span class="p">(),</span> <span class="n">kvps</span><span class="p">.</span><span class="n">end</span><span class="p">());</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</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">a = 1</span>
|
|
<span class="go">b = 2</span>
|
|
<span class="go">c = 3</span>
|
|
|
|
<span class="go">a = 1</span>
|
|
<span class="go">b = 2</span>
|
|
<span class="go">c = 3</span>
|
|
<span class="go">d = 42</span></pre><aside class="m-note m-default"><h4>Remark</h4><p>This function is morally equivalent to calling <code>insert(key, value)</code> for each key-value pair covered by the iterator range, so any values with keys already found in the table will not be replaced.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="aa757797646986f2f2cce0fa84221963e"><div>
|
|
<h3>
|
|
<div class="m-doc-template"> template<typename KeyType, typename ValueType, typename = <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/types/enable_if" target="_blank">std::enable_if_t</a><<span class="tpp-injected tpp-enable-if"><a href="#" onclick="ToggleEnableIf(this);return false;" title="std::is_convertible_v<KeyType && , std::string_view> || impl::is_wide_string<KeyType">...</a><span>std::is_convertible_v<KeyType && , std::string_view> || impl::is_wide_string<KeyType</span></span>> >>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/utility/pair" target="_blank">std::pair</a><<a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a>, bool> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#aa757797646986f2f2cce0fa84221963e">insert</a>(</span><span class="m-doc-wrap">KeyType&& key,
|
|
ValueType&& val) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Inserts a new value at a specific key if one did not already exist.</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%">KeyType</td>
|
|
<td><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string" target="_blank">std::string</a> (or a type convertible to it).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ValueType</td>
|
|
<td>One of the TOML ndoe or value types (or a type promotable to one).</td>
|
|
</tr>
|
|
</tbody>
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>key</td>
|
|
<td>The key at which to insert the new value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>val</td>
|
|
<td>The new value to insert.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td><p>A <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/utility/pair" target="_blank">std::pair</a> containing:</p><ul><li>An iterator to the insertion position (or the position of the value that prevented insertion)<br/></li><li>A boolean indicating if the insertion was successful.</li></ul></td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><p class="m-note m-success godbolt"><a class="tpp-external godbolt" href="https://godbolt.org/z/bMnW5r" target="_blank">Try this code on Compiler Explorer</a></p><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="ns">toml::</span><span class="ut">table</span><span class="p">{{</span>
|
|
<span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="mi">1</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"b"</span><span class="p">,</span> <span class="mi">2</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"c"</span><span class="p">,</span> <span class="mi">3</span> <span class="p">}</span>
|
|
<span class="p">}};</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="k">for</span> <span class="p">(</span><span class="k">auto</span> <span class="nl">k</span> <span class="p">:</span> <span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="s">"d"</span> <span class="p">})</span>
|
|
<span class="p">{</span>
|
|
<span class="k">auto</span> <span class="n">result</span> <span class="o">=</span> <span class="n">tbl</span><span class="p">.</span><span class="n">insert</span><span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="mi">42</span><span class="p">);</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="s">"inserted with key '"</span><span class="sa">sv</span> <span class="o"><<</span> <span class="n">k</span> <span class="o"><<</span> <span class="s">"': "</span><span class="sa">sv</span> <span class="o"><<</span> <span class="n">result</span><span class="p">.</span><span class="n">second</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</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">a = 1</span>
|
|
<span class="go">b = 2</span>
|
|
<span class="go">c = 3</span>
|
|
|
|
<span class="go">inserted with key 'a': false</span>
|
|
<span class="go">inserted with key 'd': true</span>
|
|
<span class="go">a = 1</span>
|
|
<span class="go">b = 2</span>
|
|
<span class="go">c = 3</span>
|
|
<span class="go">d = 42</span></pre>
|
|
</div></section>
|
|
<section class="m-doc-details" id="acb97b09eb0b36ea708178678f15d0614"><div>
|
|
<h3>
|
|
<div class="m-doc-template">
|
|
template<typename KeyType, typename ValueType>
|
|
</div>
|
|
<span class="m-doc-wrap-bumper"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/utility/pair" target="_blank">std::pair</a><<a class="m-doc" href="classtoml_1_1table.html#aeecd89b0c0b321a9aff276ff1470f1d7">iterator</a>, bool> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#acb97b09eb0b36ea708178678f15d0614">insert_or_assign</a>(</span><span class="m-doc-wrap">KeyType&& key,
|
|
ValueType&& val) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Inserts or assigns a value at a specific key.</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%">KeyType</td>
|
|
<td><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string" target="_blank">std::string</a> (or a type convertible to it).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ValueType</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>key</td>
|
|
<td>The key at which to insert or assign the value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>val</td>
|
|
<td>The value to insert/assign.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td><p>A <a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/utility/pair" target="_blank">std::pair</a> containing:</p><ul><li>An iterator to the value's position</li><li>A boolean containing <code>true</code> if the value was inserted, <code>false</code> if it was assigned.</li></ul></td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<pre class="m-code"><p class="m-note m-success godbolt"><a class="tpp-external godbolt" href="https://godbolt.org/z/ddK563" target="_blank">Try this code on Compiler Explorer</a></p><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="ns">toml::</span><span class="ut">table</span><span class="p">{{</span>
|
|
<span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="mi">1</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"b"</span><span class="p">,</span> <span class="mi">2</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"c"</span><span class="p">,</span> <span class="mi">3</span> <span class="p">}</span>
|
|
<span class="p">}};</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="k">for</span> <span class="p">(</span><span class="k">auto</span> <span class="nl">k</span> <span class="p">:</span> <span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="s">"d"</span> <span class="p">})</span>
|
|
<span class="p">{</span>
|
|
<span class="k">auto</span> <span class="n">result</span> <span class="o">=</span> <span class="n">tbl</span><span class="p">.</span><span class="n">insert_or_assign</span><span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="mi">42</span><span class="p">);</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="s">"value at key '"</span><span class="sa">sv</span> <span class="o"><<</span> <span class="n">k</span>
|
|
<span class="o"><<</span> <span class="s">"' was "</span><span class="sa">sv</span> <span class="o"><<</span> <span class="p">(</span><span class="n">result</span><span class="p">.</span><span class="n">second</span> <span class="o">?</span> <span class="s">"inserted"</span><span class="nl">sv</span> <span class="p">:</span> <span class="s">"assigned"</span><span class="sa">sv</span><span class="p">)</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</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">a = 1</span>
|
|
<span class="go">b = 2</span>
|
|
<span class="go">c = 3</span>
|
|
|
|
<span class="go">value at key 'a' was assigned</span>
|
|
<span class="go">value at key 'd' was inserted</span>
|
|
<span class="go">a = 42</span>
|
|
<span class="go">b = 2</span>
|
|
<span class="go">c = 3</span>
|
|
<span class="go">d = 42</span></pre>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a53be1b93aa90608ed378323df835a2f3"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">bool toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a53be1b93aa90608ed378323df835a2f3">is_inline</a>(</span><span class="m-doc-wrap">) const <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Returns true if this table is an inline table.</p>
|
|
<aside class="m-note m-default"><h4>Remark</h4><p>Runtime-constructed tables (i.e. those not created during parsing) are not inline by default.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a8e797a683ff2bacd14d7e7461ecd2780"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">void toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a8e797a683ff2bacd14d7e7461ecd2780">is_inline</a>(</span><span class="m-doc-wrap">bool val) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Sets whether this table is a TOML inline table.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">val</td>
|
|
<td>The new value for 'inline'.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<pre class="m-code"><p class="m-note m-success godbolt"><a class="tpp-external godbolt" href="https://godbolt.org/z/an9xdj" target="_blank">Try this code on Compiler Explorer</a></p><span class="k">auto</span> <span class="n">tbl</span> <span class="o">=</span> <span class="ns">toml::</span><span class="ut">table</span><span class="p">{{</span>
|
|
<span class="p">{</span> <span class="s">"a"</span><span class="p">,</span> <span class="mi">1</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"b"</span><span class="p">,</span> <span class="mi">2</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"c"</span><span class="p">,</span> <span class="mi">3</span> <span class="p">},</span>
|
|
<span class="p">{</span> <span class="s">"d"</span><span class="p">,</span> <span class="ns">toml::</span><span class="ut">table</span><span class="p">{{</span> <span class="p">{</span> <span class="s">"e"</span><span class="p">,</span> <span class="mi">4</span> <span class="p">}</span> <span class="p">}}</span> <span class="p">}</span>
|
|
<span class="p">}};</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="s">"is inline? "</span><span class="sa">sv</span> <span class="o"><<</span> <span class="n">tbl</span><span class="p">.</span><span class="n">is_inline</span><span class="p">()</span> <span class="o"><<</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="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n\n</span><span class="s">"</span><span class="p">;</span>
|
|
|
|
<span class="n">tbl</span><span class="p">.</span><span class="n">is_inline</span><span class="p">(</span><span class="o">!</span><span class="n">tbl</span><span class="p">.</span><span class="n">is_inline</span><span class="p">());</span>
|
|
<span class="ns">std::</span><span class="n">cout</span> <span class="o"><<</span> <span class="s">"is inline? "</span><span class="sa">sv</span> <span class="o"><<</span> <span class="n">tbl</span><span class="p">.</span><span class="n">is_inline</span><span class="p">()</span> <span class="o"><<</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="n">cout</span> <span class="o"><<</span> <span class="n">tbl</span> <span class="o"><<</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">is inline? false</span>
|
|
<span class="go">a = 1</span>
|
|
<span class="go">b = 2</span>
|
|
<span class="go">c = 3</span>
|
|
|
|
<span class="go">[d]</span>
|
|
<span class="go">e = 4</span>
|
|
|
|
|
|
<span class="go">is inline? true</span>
|
|
<span class="go">{ a = 1, b = 2, c = 3, d = { e = 4 } }</span></pre><aside class="m-note m-default"><h4>Remark</h4><p>A table being 'inline' is only relevent during printing; it has no effect on the general functionality of the table object.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a9b13a19ddfcd2f76685f57587d28701c"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><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>> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a9b13a19ddfcd2f76685f57587d28701c">operator[]</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) const <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets a <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a> for the selected key-value pair (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%">key</td>
|
|
<td>The key used for the lookup.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A view of the value at the given key if one existed, or an empty node view.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<aside class="m-note m-default"><h4>Remark</h4><p><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/container/map" target="_blank">std::map</a>::operator[]'s behaviour of default-constructing a value at a key if it didn't exist is a crazy bug factory so I've deliberately chosen not to emulate it. <strong>This is not an error.</strong></p></aside><aside class="m-note m-default"><h4>See also</h4><p><a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a></p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a6d8386049f630c8551597a2180479c7c"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><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>> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a6d8386049f630c8551597a2180479c7c">operator[]</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::string_view</a> key) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets a <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a> for the selected key-value pair.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">key</td>
|
|
<td>The key used for the lookup.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A view of the value at the given key if one existed, or an empty node view.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<aside class="m-note m-default"><h4>Remark</h4><p><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/container/map" target="_blank">std::map</a>::operator[]'s behaviour of default-constructing a value at a key if it didn't exist is a crazy bug factory so I've deliberately chosen not to emulate it. <strong>This is not an error.</strong></p></aside><aside class="m-note m-default"><h4>See also</h4><p><a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a></p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a404ae83ed52c7b8ce294d3d4925c8a16"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><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>> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a404ae83ed52c7b8ce294d3d4925c8a16">operator[]</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) const <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets a <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a> for the selected key-value pair (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%">key</td>
|
|
<td>The key used for the lookup.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A view of the value at the given key if one existed, or an empty node view.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<aside class="m-note m-default"><h4>Remark</h4><p><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/container/map" target="_blank">std::map</a>::operator[]'s behaviour of default-constructing a value at a key if it didn't exist is a crazy bug factory so I've deliberately chosen not to emulate it. <strong>This is not an error.</strong></p></aside><aside class="m-note m-default"><h4>See also</h4><p><a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a></p></aside><aside class="m-note m-warning"><h4>Attention</h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga0785b375499ea976c627d775f8fc747b">TOML_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a06fd3d9032b031b0363818939cd5cf38"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><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>> toml::<wbr/>table::<wbr/></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#a06fd3d9032b031b0363818939cd5cf38">operator[]</a>(</span><span class="m-doc-wrap"><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/string/basic_string_view" target="_blank">std::wstring_view</a> key) <span class="m-label m-success">noexcept</span></span></span>
|
|
</h3>
|
|
<p>Gets a <a class="m-doc" href="classtoml_1_1node__view.html">node_<wbr/>view</a> for the selected key-value pair.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">key</td>
|
|
<td>The key used for the lookup.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>A view of the value at the given key if one existed, or an empty node view.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<aside class="m-note m-default"><h4>Remark</h4><p><a class="m-doc tpp-injected tpp-external" href="https://en.cppreference.com/w/cpp/container/map" target="_blank">std::map</a>::operator[]'s behaviour of default-constructing a value at a key if it didn't exist is a crazy bug factory so I've deliberately chosen not to emulate it. <strong>This is not an error.</strong></p></aside><aside class="m-note m-default"><h4>See also</h4><p><a class="m-doc" href="classtoml_1_1node__view.html">toml::<wbr/>node_view</a></p></aside><aside class="m-note m-warning"><h4>Attention</h4><p>This overload is only available when <a class="m-doc" href="group__configuration.html#ga0785b375499ea976c627d775f8fc747b">TOML_<wbr/>WINDOWS_<wbr/>COMPAT</a> is enabled.</p></aside>
|
|
</div></section>
|
|
<section class="m-doc-details" id="abdeb5d9d9fc23c031c78e544c6196ea6"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">bool </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#abdeb5d9d9fc23c031c78e544c6196ea6">operator!=</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1table.html">table</a>& lhs,
|
|
const <a class="m-doc" href="classtoml_1_1table.html">table</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 table.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>rhs</td>
|
|
<td>The RHS table.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>True if the tables did not contain the same keys and map.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="af8ebaed8105e5de2098992764f2d534a"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">bool </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a class="m-doc-self" href="#af8ebaed8105e5de2098992764f2d534a">operator==</a>(</span><span class="m-doc-wrap">const <a class="m-doc" href="classtoml_1_1table.html">table</a>& lhs,
|
|
const <a class="m-doc" href="classtoml_1_1table.html">table</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 table.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>rhs</td>
|
|
<td>The RHS table.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>True if the tables contained the same keys and map.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</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-v1.js"></script>
|
|
<script async="async" src="searchdata-v1.js"></script>
|
|
<footer><nav>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<a class="tpp-external" href="https://github.com/marzer/tomlplusplus/" target="_blank">Github</a>
|
|
•
|
|
|
|
<a class="tpp-external" href="https://github.com/marzer/tomlplusplus/issues" target="_blank">Report
|
|
an
|
|
issue</a>
|
|
|
|
<br/><br/>Documentation
|
|
generated
|
|
using
|
|
<a class="tpp-external" href="https://mcss.mosra.cz/" target="_blank">m.css</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></footer>
|
|
|
|
|
|
</body></html> |