Files
tomlplusplus/annotated.html
2022-04-22 20:34:39 +00:00

161 lines
10 KiB
HTML

<!DOCTYPE html>
<html lang="en"><head>
<meta charset="utf-8"/>
<title>toml++ TOML for C++</title>
<link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" rel="stylesheet"/>
<link href="m-dark+documentation.compiled.css" rel="stylesheet"/>
<link href="favicon.ico" rel="icon" type="image/vnd.microsoft.icon"/>
<meta content="width=device-width, initial-scale=1.0" name="viewport"/>
<meta content="#22272e" name="theme-color"/>
<meta content="toml++" name="twitter:title"/>
<meta content="toml++" property="og:title"/>
<meta content="toml++" itemprop="name"/>
<meta content="Mark Gillard" name="author"/>
<meta content="Mark Gillard" property="article:author"/>
<meta content="TOML for C++" name="description"/>
<meta content="TOML for C++" name="twitter:description"/>
<meta content="TOML for C++" property="og:description"/>
<meta content="TOML for C++" itemprop="description"/>
<meta content="telephone=no" name="format-detection"/>
<meta content="Poxy v0.5.5" name="generator"/>
<meta content="no-referrer-when-downgrade" name="referrer"/>
<meta content="gbtcNgKlNiPSMKkYMw4zWFVWGPH_oU93m9n_-nb4qK8" name="google-site-verification"/>
<link href="poxy-0.5.5.css" rel="stylesheet"/>
<link href="poxy-0.5.5-dark.css" rel="stylesheet"/>
<script src="poxy-0.5.5.js"></script>
</head>
<body>
<header><nav id="navigation">
<div class="m-container">
<div class="m-row">
<a class="m-col-t-8 m-col-m-none m-left-m" href="index.html" id="m-navbar-brand"><img alt="" src="logo.png"/>toml++ <span class="m-thin">TOML for C++</span></a>
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
<a class="m-doc-search-icon" href="#search" onclick="return showSearch()" title="Search"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<path d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z" id="m-doc-search-icon-path"></path>
</svg></a>
<a href="#navigation" id="m-navbar-show" title="Show navigation"></a>
<a href="#" id="m-navbar-hide" title="Hide navigation"></a>
</div>
<div class="m-col-t-12 m-show-m m-col-m-none m-right-m" id="m-navbar-collapse">
<div class="m-row">
<ol class="m-col-t-6 m-col-m-none">
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="annotated.html" id="m-navbar-current">Classes</a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="3">
<li><a class="github poxy-external" href="https://github.com/marzer/tomlplusplus/" target="_blank">Github</a></li>
<li class="m-show-m"><a class="m-doc-search-icon" href="#search" onclick="return showSearch()" title="Search"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path"></use>
</svg></a></li>
</ol>
</div>
</div>
</div>
</div>
</nav></header>
<main><article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>Classes</h1>
<ul class="m-doc">
<li class="m-doc-collapsible">
<a href="#" onclick="return toggle(this)">namespace</a> <a class="m-doc" href="namespacetoml.html">toml</a> <span class="m-doc">The root namespace for all toml++ functions and types.</span>
<ul class="m-doc">
<li>namespace <a class="m-doc" href="namespacetoml_1_1literals.html">literals</a> <span class="m-label m-flat m-info">inline</span> <span class="m-doc">Convenience literal operators for working with toml++.</span></li>
<li>class <a class="m-doc" href="classtoml_1_1array.html">array</a> <span class="m-doc">A TOML array.</span></li>
<li>struct <a class="m-doc" href="structtoml_1_1date.html">date</a> <span class="m-doc">A local date.</span></li>
<li>struct <a class="m-doc" href="structtoml_1_1date__time.html">date_time</a> <span class="m-doc">A <a class="m-doc poxy-injected" href="structtoml_1_1date__time.html">date-time</a>.</span></li>
<li>struct <a class="m-doc" href="structtoml_1_1inserter.html">inserter</a> <span class="m-doc">Helper class for suppressing move-construction in single-argument array constructors.</span></li>
<li>class <a class="m-doc" href="classtoml_1_1json__formatter.html">json_formatter</a> <span class="m-doc">A wrapper for printing TOML objects out to a stream as formatted JSON.</span></li>
<li>class <a class="m-doc" href="classtoml_1_1key.html">key</a> <span class="m-doc">A key parsed from a TOML document.</span></li>
<li>class <a class="m-doc" href="classtoml_1_1node.html">node</a> <span class="m-doc">A TOML node.</span></li>
<li>class <a class="m-doc" href="classtoml_1_1node__view.html">node_view</a> <span class="m-doc">A view of a node.</span></li>
<li>class <a class="m-doc" href="classtoml_1_1parse__error.html">parse_error</a> <span class="m-doc">An error generated when parsing fails.</span></li>
<li>class <a class="m-doc" href="classtoml_1_1parse__result.html">parse_result</a> <span class="m-doc">The result of a parsing operation.</span></li>
<li>struct <a class="m-doc" href="structtoml_1_1source__position.html">source_position</a> <span class="m-doc">A source document line-and-column pair.</span></li>
<li>struct <a class="m-doc" href="structtoml_1_1source__region.html">source_region</a> <span class="m-doc">A source document region.</span></li>
<li>class <a class="m-doc" href="classtoml_1_1table.html">table</a> <span class="m-doc">A TOML table.</span></li>
<li>struct <a class="m-doc" href="structtoml_1_1time.html">time</a> <span class="m-doc">A local time-of-day.</span></li>
<li>struct <a class="m-doc" href="structtoml_1_1time__offset.html">time_offset</a> <span class="m-doc">A timezone offset.</span></li>
<li>class <a class="m-doc" href="classtoml_1_1toml__formatter.html">toml_formatter</a> <span class="m-doc">A wrapper for printing TOML objects out to a stream as formatted TOML.</span></li>
<li>class <a class="m-doc" href="classtoml_1_1value.html">value</a> <span class="m-doc">A TOML value.</span></li>
<li>class <a class="m-doc" href="classtoml_1_1yaml__formatter.html">yaml_formatter</a> <span class="m-doc">A wrapper for printing TOML objects out to a stream as formatted YAML.</span></li>
</ul>
</li>
</ul>
<script>
function toggle(e) {
e.parentElement.className = e.parentElement.className == 'm-doc-collapsible' ?
'm-doc-expansible' : 'm-doc-collapsible';
return false;
}
/* Collapse all nodes marked as such. Doing it via JS instead of
directly in markup so disabling it doesn't harm usability. The list
is somehow regenerated on every iteration and shrinks as I change
the classes. It's not documented anywhere and I'm not sure if this
is the same across browsers, so I am going backwards in that list to
be sure. */
var collapsed = document.getElementsByClassName("collapsed");
for(var i = collapsed.length - 1; i >= 0; --i)
collapsed[i].className = 'm-doc-expansible';
</script>
</div>
</div>
</div>
</article></main>
<div class="m-doc-search" id="search">
<a href="#!" onclick="return hideSearch()"></a>
<div class="m-container">
<div class="m-row">
<div class="m-col-m-8 m-push-m-2">
<div class="m-doc-search-header m-text m-small">
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
<div id="search-symbolcount"></div>
</div>
<div class="m-doc-search-content">
<form>
<input autocomplete="off" autofocus="autofocus" disabled="disabled" id="search-input" name="q" placeholder="Loading …" spellcheck="false" type="search"/>
</form>
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
<div class="m-text m-dim m-text-center" id="search-help">
<p class="m-noindent">Search for symbols, directories, files, pages or
modules. You can omit any prefix from the symbol or file path; adding a
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
directory.</p>
<p class="m-noindent">Use <span class="m-label m-dim"></span>
/ <span class="m-label m-dim"></span> to navigate through the list,
<span class="m-label m-dim">Enter</span> to go.
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
copy a link to the result using <span class="m-label m-dim"></span>
<span class="m-label m-dim">L</span> while <span class="m-label m-dim"></span>
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
</div>
<div class="m-text m-warning m-text-center" id="search-notfound">Sorry, nothing was found.</div>
<ul id="search-results"></ul>
</div>
</div>
</div>
</div>
</div>
<script src="search-v2.js"></script>
<script async="async" src="searchdata-v2.js"></script>
<footer><nav>
<div class="m-container">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<a class="poxy-external" href="https://github.com/marzer/tomlplusplus/" target="_blank">Github</a>
<a class="poxy-external" href="https://github.com/marzer/tomlplusplus/issues" target="_blank">Report an issue</a>
<a class="poxy-external" href="https://github.com/marzer/tomlplusplus/blob/master/LICENSE" target="_blank">License</a>
<a download="" href="toml++.tagfile.xml" target="_blank" type="text/xml">Doxygen tagfile</a>
<br/><br/>
Site generated using <a class="poxy-external" href="https://github.com/marzer/poxy/" target="_blank">Poxy</a>
</div>
</div>
</div>
</nav></footer>
</body></html>