mirror of
https://github.com/ToruNiina/toml11.git
synced 2025-09-17 09:08:08 +08:00
44 lines
13 KiB
HTML
44 lines
13 KiB
HTML
<!doctype html><html lang=en dir=ltr><head><meta charset=UTF-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="
|
|
Features
|
|
#
|
|
|
|
This section explains the main features provided by toml11, with examples.
|
|
|
|
Parsing Files and Strings
|
|
#
|
|
|
|
Describes the functions for parsing files and strings, and how to handle the errors they produce.
|
|
Includes:
|
|
|
|
Parsing files
|
|
Parsing strings
|
|
Parsing byte arrays
|
|
Parsing files without throwing exceptions
|
|
Parsing strings without throwing exceptions
|
|
Parsing byte arrays without throwing exceptions
|
|
|
|
|
|
Extracting Values from toml::value
|
|
#
|
|
|
|
Explains how to examine, extract, and convert the data types held by toml::value."><meta name=theme-color media="(prefers-color-scheme: light)" content="#ffffff"><meta name=theme-color media="(prefers-color-scheme: dark)" content="#343a40"><meta name=color-scheme content="light dark"><meta property="og:url" content="https://toruniina.github.io/toml11/docs/features/"><meta property="og:site_name" content="toml11"><meta property="og:title" content="features"><meta property="og:description" content="Features # This section explains the main features provided by toml11, with examples.
|
|
Parsing Files and Strings # Describes the functions for parsing files and strings, and how to handle the errors they produce.
|
|
Includes:
|
|
Parsing files Parsing strings Parsing byte arrays Parsing files without throwing exceptions Parsing strings without throwing exceptions Parsing byte arrays without throwing exceptions Extracting Values from toml::value # Explains how to examine, extract, and convert the data types held by toml::value."><meta property="og:locale" content="en"><meta property="og:type" content="website"><title>features | toml11</title>
|
|
<link rel=manifest href=/toml11/manifest.json><link rel=icon href=/toml11/favicon.png><link rel=canonical href=https://toruniina.github.io/toml11/docs/features/><link rel=alternate hreflang=ja href=https://toruniina.github.io/toml11/ja/docs/features/ title=features><link rel=stylesheet href=/toml11/book.min.ddac3efe7ea4c1007ff53e5a8fd67f12517e5d2e99984d8c67a18668f7ecaa03.css integrity="sha256-3aw+/n6kwQB/9T5aj9Z/ElF+XS6ZmE2MZ6GGaPfsqgM=" crossorigin=anonymous><script defer src=/toml11/fuse.min.js></script><script defer src=/toml11/en.search.min.db4a558804ac41f081539588cec8e4a415587801da466728166bb5341dd62411.js integrity="sha256-20pViASsQfCBU5WIzsjkpBVYeAHaRmcoFmu1NB3WJBE=" crossorigin=anonymous></script><link rel=alternate type=application/rss+xml href=https://toruniina.github.io/toml11/docs/features/index.xml title=toml11></head><body dir=ltr><input type=checkbox class="hidden toggle" id=menu-control>
|
|
<input type=checkbox class="hidden toggle" id=toc-control><main class="container flex"><aside class=book-menu><div class=book-menu-content><nav><h2 class=book-brand><a class="flex align-center" href=/toml11/><span>toml11</span></a></h2><div class="book-search hidden"><input type=text id=book-search-input placeholder=Search aria-label=Search maxlength=64 data-hotkeys=s/><div class="book-search-spinner hidden"></div><ul id=book-search-results></ul></div><script>document.querySelector(".book-search").classList.remove("hidden")</script><ul class=book-languages><li><input type=checkbox id=languages class=toggle>
|
|
<label for=languages class="flex justify-between"><a role=button class="flex align-center"><img src=/toml11/svg/translate.svg class=book-icon alt=Languages>
|
|
English</a></label><ul><li><a href=https://toruniina.github.io/toml11/ja/docs/features/>日本語</a></li></ul></li></ul><ul><li><a href=/toml11/docs/installation/>installation</a><ul></ul></li><li><input type=checkbox id=section-291123c850af98d8b815ccdbb4c33657 class=toggle checked>
|
|
<label for=section-291123c850af98d8b815ccdbb4c33657 class="flex justify-between"><a href=/toml11/docs/features/ class=active>features</a></label><ul><li><a href=/toml11/docs/features/parsing_files/>parsing files</a></li><li><a href=/toml11/docs/features/value/>getting values</a></li><li><a href=/toml11/docs/features/error_message/>error message</a></li><li><a href=/toml11/docs/features/serialize/>serializing values</a></li><li><a href=/toml11/docs/features/configure_types/>configuring types</a></li><li><a href=/toml11/docs/features/literal/>toml literal</a></li><li><a href=/toml11/docs/features/toml_spec/>toml spec</a></li><li><a href=/toml11/docs/features/extension/>extension</a></li></ul></li><li><input type=checkbox id=section-e2e812e55021b82e114feaae98f1a02e class=toggle>
|
|
<label for=section-e2e812e55021b82e114feaae98f1a02e class="flex justify-between"><a href=/toml11/docs/reference/>reference</a></label><ul><li><a href=/toml11/docs/reference/color/>color.hpp</a></li><li><a href=/toml11/docs/reference/comments/>comments.hpp</a></li><li><a href=/toml11/docs/reference/conversion/>conversion.hpp</a></li><li><a href=/toml11/docs/reference/datetime/>datetime.hpp</a></li><li><a href=/toml11/docs/reference/error_info/>error_info.hpp</a></li><li><a href=/toml11/docs/reference/exception/>exception.hpp</a></li><li><a href=/toml11/docs/reference/find/>find.hpp</a></li><li><a href=/toml11/docs/reference/format/>format.hpp</a></li><li><a href=/toml11/docs/reference/from/>from.hpp</a></li><li><a href=/toml11/docs/reference/get/>get.hpp</a></li><li><a href=/toml11/docs/reference/into/>into.hpp</a></li><li><a href=/toml11/docs/reference/literal/>literal.hpp</a></li><li><a href=/toml11/docs/reference/ordered_map/>ordered_map.hpp</a></li><li><a href=/toml11/docs/reference/parser/>parser.hpp</a></li><li><a href=/toml11/docs/reference/result/>result.hpp</a></li><li><a href=/toml11/docs/reference/serializer/>serializer.hpp</a></li><li><a href=/toml11/docs/reference/source_location/>source_location.hpp</a></li><li><a href=/toml11/docs/reference/spec/>spec.hpp</a></li><li><a href=/toml11/docs/reference/toml_fwd/>toml_fwd.hpp</a></li><li><a href=/toml11/docs/reference/toml/>toml.hpp</a></li><li><a href=/toml11/docs/reference/types/>types.hpp</a></li><li><a href=/toml11/docs/reference/value_t/>value_t.hpp</a></li><li><a href=/toml11/docs/reference/value/>value.hpp</a></li><li><a href=/toml11/docs/reference/version/>version.hpp</a></li><li><a href=/toml11/docs/reference/visit/>visit.hpp</a></li></ul></li><li><a href=/toml11/docs/changelog/>changelog</a><ul></ul></li></ul><ul><li><a href=https://github.com/ToruNiina/toml11 target=_blank rel=noopener>GitHub</a></li></ul></nav><script>(function(){var e=document.querySelector("aside .book-menu-content");addEventListener("beforeunload",function(){localStorage.setItem("menu.scrollTop",e.scrollTop)}),e.scrollTop=localStorage.getItem("menu.scrollTop")})()</script></div></aside><div class=book-page><header class=book-header><div class="flex align-center justify-between"><label for=menu-control><img src=/toml11/svg/menu.svg class=book-icon alt=Menu>
|
|
</label><strong>features</strong>
|
|
<label for=toc-control><img src=/toml11/svg/toc.svg class=book-icon alt="Table of Contents"></label></div><aside class="hidden clearfix"><nav id=TableOfContents><ul><li><a href=#features>Features</a><ul><li><a href=#parsing-files-and-strings><a href=parsing_files>Parsing Files and Strings</a></a></li><li><a href=#extracting-values-from><a href=value>Extracting Values from <code>toml::value</code></a></a></li><li><a href=#creating-error-messages><a href=error_message>Creating Error Messages</a></a></li><li><a href=#serializing-toml-files><a href=serialize>Serializing TOML Files</a></a></li><li><a href=#configuring-types-of><a href=configure_types>Configuring Types of <code>toml::value</code></a></a></li><li><a href=#toml-literals><a href=literal>TOML Literals</a></a></li><li><a href=#toml-language-version><a href=toml_spec>TOML Language Version</a></a></li><li><a href=#toml-language-extensions><a href=extension>TOML Language Extensions</a></a></li></ul></li></ul></nav></aside></header><article class="markdown book-article"><h1 id=features>Features
|
|
<a class=anchor href=#features>#</a></h1><p>This section explains the main features provided by toml11, with examples.</p><h2 id=parsing-files-and-strings><a href=parsing_files>Parsing Files and Strings</a>
|
|
<a class=anchor href=#parsing-files-and-strings>#</a></h2><p>Describes the functions for parsing files and strings, and how to handle the errors they produce.</p><p>Includes:</p><ul><li>Parsing files</li><li>Parsing strings</li><li>Parsing byte arrays</li><li>Parsing files without throwing exceptions</li><li>Parsing strings without throwing exceptions</li><li>Parsing byte arrays without throwing exceptions</li></ul><h2 id=extracting-values-from><a href=value>Extracting Values from <code>toml::value</code></a>
|
|
<a class=anchor href=#extracting-values-from>#</a></h2><p>Explains how to examine, extract, and convert the data types held by <code>toml::value</code>.</p><p>Includes:</p><ul><li>Checking the type of a value using member functions</li><li>Accessing values using member functions</li><li>Accessing comments</li><li>Handling inline tables and dotted keys</li><li>Handling date information</li><li>Using <code>toml::get<T></code> for conversion</li><li>Using <code>toml::get_or</code> to specify a fallback value</li><li>Using <code>toml::find<T></code> for searching and conversion</li><li>Using <code>toml::find_or</code> to specify a fallback value</li><li>Defining conversions with user-defined types</li><li>Applying functions with <code>toml::visit</code></li><li>Constructing <code>toml::value</code></li></ul><h2 id=creating-error-messages><a href=error_message>Creating Error Messages</a>
|
|
<a class=anchor href=#creating-error-messages>#</a></h2><p>Explains how to generate error messages with location information from a TOML file using <code>toml::value</code>.</p><p>Includes:</p><ul><li>Extracting location information from <code>toml::value</code></li><li>Constructing error messages</li><li>Adding color to the output</li></ul><h2 id=serializing-toml-files><a href=serialize>Serializing TOML Files</a>
|
|
<a class=anchor href=#serializing-toml-files>#</a></h2><p>Describes how to format the values of <code>toml::value</code> and the available formatting options.</p><p>Includes:</p><ul><li>Specifying formats for each value of <code>toml::value</code></li><li>Formatting <code>toml::value</code> into a string</li></ul><h2 id=configuring-types-of><a href=configure_types>Configuring Types of <code>toml::value</code></a>
|
|
<a class=anchor href=#configuring-types-of>#</a></h2><p>Explains how to customize the types stored in <code>toml::value</code> (such as <code>integer_type</code> and <code>table_type</code>).</p><p>Includes:</p><ul><li>Defining <code>type_config</code></li><li>Using <code>ordered_type_config</code></li><li>Disabling comment preservation</li><li>Using different containers like <code>std::deque</code></li><li>Using different numeric types like <code>boost::multiprecision</code></li></ul><h2 id=toml-literals><a href=literal>TOML Literals</a>
|
|
<a class=anchor href=#toml-literals>#</a></h2><p>Explains the <code>_toml</code> literal for embedding TOML files directly in C++ code.</p><p>Includes:</p><ul><li>Using TOML literals</li></ul><h2 id=toml-language-version><a href=toml_spec>TOML Language Version</a>
|
|
<a class=anchor href=#toml-language-version>#</a></h2><p>Describes the versions of the TOML language supported by toml11 and how to control language features added in TOML-v1.1.0.</p><p>Includes:</p><ul><li>Using TOML language version 1.1.0</li><li>Using specific features of TOML language version 1.1.0</li></ul><h2 id=toml-language-extensions><a href=extension>TOML Language Extensions</a>
|
|
<a class=anchor href=#toml-language-extensions>#</a></h2><p>Explains the custom extensions to the TOML language provided by toml11.</p><p>Includes:</p><ul><li>Supporting <code>null</code></li><li>Supporting hexadecimal format for floating-point numbers</li><li>Allowing units for numbers</li></ul></article><footer class=book-footer><div class="flex flex-wrap justify-between"></div><script>(function(){function e(e){const t=window.getSelection(),n=document.createRange();n.selectNodeContents(e),t.removeAllRanges(),t.addRange(n)}document.querySelectorAll("pre code").forEach(t=>{t.addEventListener("click",function(){if(window.getSelection().toString())return;e(t.parentElement),navigator.clipboard&&navigator.clipboard.writeText(t.parentElement.textContent)})})})()</script></footer><label for=menu-control class="hidden book-menu-overlay"></label></div><aside class=book-toc><div class=book-toc-content><nav id=TableOfContents><ul><li><a href=#features>Features</a><ul><li><a href=#parsing-files-and-strings><a href=parsing_files>Parsing Files and Strings</a></a></li><li><a href=#extracting-values-from><a href=value>Extracting Values from <code>toml::value</code></a></a></li><li><a href=#creating-error-messages><a href=error_message>Creating Error Messages</a></a></li><li><a href=#serializing-toml-files><a href=serialize>Serializing TOML Files</a></a></li><li><a href=#configuring-types-of><a href=configure_types>Configuring Types of <code>toml::value</code></a></a></li><li><a href=#toml-literals><a href=literal>TOML Literals</a></a></li><li><a href=#toml-language-version><a href=toml_spec>TOML Language Version</a></a></li><li><a href=#toml-language-extensions><a href=extension>TOML Language Extensions</a></a></li></ul></li></ul></nav></div></aside></main></body></html> |