mirror of
https://github.com/ToruNiina/toml11.git
synced 2025-09-18 19:10:11 +08:00
139 lines
19 KiB
HTML
139 lines
19 KiB
HTML
<!doctype html><html lang=ja dir=ltr><head><meta charset=UTF-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content='
|
|
Reference
|
|
#
|
|
|
|
以下では、toml11が公開するクラスと関数の効果を説明します。
|
|
|
|
ディレクトリ構造
|
|
#
|
|
|
|
toml.hpp と toml_fwd.hpp は ${TOML11_INCLUDE_DIR} にあります。
|
|
他のファイルは、${TOML11_INCLUDE_DIR}/toml11 にあります。
|
|
もし各機能のファイルを個別に #include したい場合は、 #include <toml11/color.hpp> としてください。
|
|
全てを一度に #include する場合は、 #include <toml.hpp> としてください。
|
|
|
|
color.hpp
|
|
#
|
|
|
|
エラーメッセージの色付けに関する関数を定義します。
|
|
|
|
comments.hpp
|
|
#
|
|
|
|
コメントを持つpreserve_comment型とdiscard_comment型を定義します。
|
|
|
|
conversion.hpp
|
|
#
|
|
|
|
toml::valueとユーザー定義クラスを自動的に変換するマクロを定義します。
|
|
|
|
datetime.hpp
|
|
#
|
|
|
|
日時情報を持つクラスを定義します。
|
|
|
|
error_info.hpp
|
|
#
|
|
|
|
エラー情報を持つクラスを定義します。
|
|
|
|
exception.hpp
|
|
#
|
|
|
|
toml11で使用される例外の基底クラス、toml::exceptionを定義します。
|
|
|
|
find.hpp
|
|
#
|
|
|
|
値を探し変換するtoml::find関数を定義します。
|
|
|
|
format.hpp
|
|
#
|
|
|
|
値のフォーマット情報を持つクラスを定義します。
|
|
|
|
from.hpp
|
|
#
|
|
|
|
ユーザー定義型を変換するためのfrom<T>型の前方宣言です。
|
|
|
|
get.hpp
|
|
#
|
|
|
|
toml::valueの値を取り出し変換するtoml::get<T>関数を定義します。
|
|
|
|
into.hpp
|
|
#
|
|
|
|
ユーザー定義型を変換するためのinto<T>型の前方宣言です。
|
|
|
|
literal.hpp
|
|
#
|
|
|
|
operator"" _tomlリテラルを定義します。
|
|
|
|
ordered_map.hpp
|
|
#
|
|
|
|
toml::ordered_mapを定義します。
|
|
|
|
parser.hpp
|
|
#
|
|
|
|
ファイルまたは文字列をパースする関数を定義します。'><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/ja/docs/reference/"><meta property="og:site_name" content="toml11"><meta property="og:title" content="reference"><meta property="og:description" content='Reference # 以下では、toml11が公開するクラスと関数の効果を説明します。
|
|
ディレクトリ構造 # toml.hpp と toml_fwd.hpp は ${TOML11_INCLUDE_DIR} にあります。 他のファイルは、${TOML11_INCLUDE_DIR}/toml11 にあります。
|
|
もし各機能のファイルを個別に #include したい場合は、 #include <toml11/color.hpp> としてください。 全てを一度に #include する場合は、 #include <toml.hpp> としてください。
|
|
color.hpp # エラーメッセージの色付けに関する関数を定義します。
|
|
comments.hpp # コメントを持つpreserve_comment型とdiscard_comment型を定義します。
|
|
conversion.hpp # toml::valueとユーザー定義クラスを自動的に変換するマクロを定義します。
|
|
datetime.hpp # 日時情報を持つクラスを定義します。
|
|
error_info.hpp # エラー情報を持つクラスを定義します。
|
|
exception.hpp # toml11で使用される例外の基底クラス、toml::exceptionを定義します。
|
|
find.hpp # 値を探し変換するtoml::find関数を定義します。
|
|
format.hpp # 値のフォーマット情報を持つクラスを定義します。
|
|
from.hpp # ユーザー定義型を変換するためのfrom<T>型の前方宣言です。
|
|
get.hpp # toml::valueの値を取り出し変換するtoml::get<T>関数を定義します。
|
|
into.hpp # ユーザー定義型を変換するためのinto<T>型の前方宣言です。
|
|
literal.hpp # operator"" _tomlリテラルを定義します。
|
|
ordered_map.hpp # toml::ordered_mapを定義します。
|
|
parser.hpp # ファイルまたは文字列をパースする関数を定義します。'><meta property="og:locale" content="ja"><meta property="og:type" content="website"><title>reference | 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/ja/docs/reference/><link rel=alternate hreflang=en href=https://toruniina.github.io/toml11/docs/reference/ title=reference><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/ja.search.min.13aefbf6a803b591c02d5bc9a01dfe65fe37c31e2915c91573708d38e805d86c.js integrity="sha256-E6779qgDtZHALVvJoB3+Zf43wx4pFckVc3CNOOgF2Gw=" crossorigin=anonymous></script><link rel=alternate type=application/rss+xml href=https://toruniina.github.io/toml11/ja/docs/reference/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/ja/><span>toml11</span></a></h2><div class="book-search hidden"><input type=text id=book-search-input placeholder=検索 aria-label=検索 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>
|
|
日本語</a></label><ul><li><a href=https://toruniina.github.io/toml11/docs/reference/>English</a></li></ul></li></ul><ul><li><a href=/toml11/ja/docs/installation/>installation</a><ul></ul></li><li><input type=checkbox id=section-b4cfb5b55e913a8d853eacf5e8fba05f class=toggle>
|
|
<label for=section-b4cfb5b55e913a8d853eacf5e8fba05f class="flex justify-between"><a href=/toml11/ja/docs/features/>features</a></label><ul><li><a href=/toml11/ja/docs/features/parsing_files/>parsing files</a></li><li><a href=/toml11/ja/docs/features/value/>getting values</a></li><li><a href=/toml11/ja/docs/features/error_message/>error message</a></li><li><a href=/toml11/ja/docs/features/serialize/>serializing values</a></li><li><a href=/toml11/ja/docs/features/configure_types/>configuring types</a></li><li><a href=/toml11/ja/docs/features/literal/>toml literal</a></li><li><a href=/toml11/ja/docs/features/toml_spec/>toml spec</a></li><li><a href=/toml11/ja/docs/features/extension/>extension</a></li></ul></li><li><input type=checkbox id=section-01b096afc5186aea96713b408b47c967 class=toggle checked>
|
|
<label for=section-01b096afc5186aea96713b408b47c967 class="flex justify-between"><a href=/toml11/ja/docs/reference/ class=active>reference</a></label><ul><li><a href=/toml11/ja/docs/reference/color/>color.hpp</a></li><li><a href=/toml11/ja/docs/reference/comments/>comments.hpp</a></li><li><a href=/toml11/ja/docs/reference/conversion/>conversion.hpp</a></li><li><a href=/toml11/ja/docs/reference/datetime/>datetime.hpp</a></li><li><a href=/toml11/ja/docs/reference/error_info/>error_info.hpp</a></li><li><a href=/toml11/ja/docs/reference/exception/>exception.hpp</a></li><li><a href=/toml11/ja/docs/reference/find/>find.hpp</a></li><li><a href=/toml11/ja/docs/reference/format/>format.hpp</a></li><li><a href=/toml11/ja/docs/reference/from/>from.hpp</a></li><li><a href=/toml11/ja/docs/reference/get/>get.hpp</a></li><li><a href=/toml11/ja/docs/reference/into/>into.hpp</a></li><li><a href=/toml11/ja/docs/reference/literal/>literal.hpp</a></li><li><a href=/toml11/ja/docs/reference/ordered_map/>ordered_map.hpp</a></li><li><a href=/toml11/ja/docs/reference/parser/>parser.hpp</a></li><li><a href=/toml11/ja/docs/reference/result/>result.hpp</a></li><li><a href=/toml11/ja/docs/reference/serializer/>serializer.hpp</a></li><li><a href=/toml11/ja/docs/reference/source_location/>source_location.hpp</a></li><li><a href=/toml11/ja/docs/reference/spec/>spec.hpp</a></li><li><a href=/toml11/ja/docs/reference/toml_fwd/>toml_fwd.hpp</a></li><li><a href=/toml11/ja/docs/reference/toml/>toml.hpp</a></li><li><a href=/toml11/ja/docs/reference/types/>types.hpp</a></li><li><a href=/toml11/ja/docs/reference/value_t/>value_t.hpp</a></li><li><a href=/toml11/ja/docs/reference/value/>value.hpp</a></li><li><a href=/toml11/ja/docs/reference/version/>version.hpp</a></li><li><a href=/toml11/ja/docs/reference/visit/>visit.hpp</a></li></ul></li><li><a href=/toml11/ja/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>reference</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=#reference>Reference</a><ul><li><a href=#ディレクトリ構造>ディレクトリ構造</a></li><li><a href=#colorhpp><a href=color>color.hpp</a></a></li><li><a href=#commentshpp><a href=comments>comments.hpp</a></a></li><li><a href=#conversionhpp><a href=conversion>conversion.hpp</a></a></li><li><a href=#datetimehpp><a href=datetime>datetime.hpp</a></a></li><li><a href=#error_><a href=error_info>error_info.hpp</a></a></li><li><a href=#exceptionhpp><a href=exception>exception.hpp</a></a></li><li><a href=#findhpp><a href=find>find.hpp</a></a></li><li><a href=#formathpp><a href=format>format.hpp</a></a></li><li><a href=#fromhpp><a href=from>from.hpp</a></a></li><li><a href=#gethpp><a href=get>get.hpp</a></a></li><li><a href=#intohpp><a href=into>into.hpp</a></a></li><li><a href=#literalhpp><a href=literal>literal.hpp</a></a></li><li><a href=#ordered_><a href=ordered_map>ordered_map.hpp</a></a></li><li><a href=#parserhpp><a href=parser>parser.hpp</a></a></li><li><a href=#resulthpp><a href=result>result.hpp</a></a></li><li><a href=#serializerhpp><a href=serializer>serializer.hpp</a></a></li><li><a href=#source_><a href=source_location>source_location.hpp</a></a></li><li><a href=#spechpp><a href=spec>spec.hpp</a></a></li><li><a href=#tomlhpp><a href=toml>toml.hpp</a></a></li><li><a href=#toml_><a href=toml_fwd>toml_fwd.hpp</a></a></li><li><a href=#typeshpp><a href=types>types.hpp</a></a></li><li><a href=#valuehpp><a href=value>value.hpp</a></a></li><li><a href=#value_><a href=value_t>value_t.hpp</a></a></li><li><a href=#versionhpp><a href=version>version.hpp</a></a></li><li><a href=#visithpp><a href=visit>visit.hpp</a></a></li><li><a href=#備考>備考</a></li></ul></li></ul></nav></aside></header><article class="markdown book-article"><h1 id=reference>Reference
|
|
<a class=anchor href=#reference>#</a></h1><p>以下では、toml11が公開するクラスと関数の効果を説明します。</p><h2 id=ディレクトリ構造>ディレクトリ構造
|
|
<a class=anchor href=#%e3%83%87%e3%82%a3%e3%83%ac%e3%82%af%e3%83%88%e3%83%aa%e6%a7%8b%e9%80%a0>#</a></h2><p><code>toml.hpp</code> と <code>toml_fwd.hpp</code> は <code>${TOML11_INCLUDE_DIR}</code> にあります。
|
|
他のファイルは、<code>${TOML11_INCLUDE_DIR}/toml11</code> にあります。</p><p>もし各機能のファイルを個別に <code>#include</code> したい場合は、 <code>#include <toml11/color.hpp></code> としてください。
|
|
全てを一度に <code>#include</code> する場合は、 <code>#include <toml.hpp></code> としてください。</p><h2 id=colorhpp><a href=color>color.hpp</a>
|
|
<a class=anchor href=#colorhpp>#</a></h2><p>エラーメッセージの色付けに関する関数を定義します。</p><h2 id=commentshpp><a href=comments>comments.hpp</a>
|
|
<a class=anchor href=#commentshpp>#</a></h2><p>コメントを持つ<code>preserve_comment</code>型と<code>discard_comment</code>型を定義します。</p><h2 id=conversionhpp><a href=conversion>conversion.hpp</a>
|
|
<a class=anchor href=#conversionhpp>#</a></h2><p><code>toml::value</code>とユーザー定義クラスを自動的に変換するマクロを定義します。</p><h2 id=datetimehpp><a href=datetime>datetime.hpp</a>
|
|
<a class=anchor href=#datetimehpp>#</a></h2><p>日時情報を持つクラスを定義します。</p><h2 id=error_><a href=error_info>error_info.hpp</a>
|
|
<a class=anchor href=#error_>#</a></h2><p>エラー情報を持つクラスを定義します。</p><h2 id=exceptionhpp><a href=exception>exception.hpp</a>
|
|
<a class=anchor href=#exceptionhpp>#</a></h2><p>toml11で使用される例外の基底クラス、<code>toml::exception</code>を定義します。</p><h2 id=findhpp><a href=find>find.hpp</a>
|
|
<a class=anchor href=#findhpp>#</a></h2><p>値を探し変換する<code>toml::find</code>関数を定義します。</p><h2 id=formathpp><a href=format>format.hpp</a>
|
|
<a class=anchor href=#formathpp>#</a></h2><p>値のフォーマット情報を持つクラスを定義します。</p><h2 id=fromhpp><a href=from>from.hpp</a>
|
|
<a class=anchor href=#fromhpp>#</a></h2><p>ユーザー定義型を変換するための<code>from<T></code>型の前方宣言です。</p><h2 id=gethpp><a href=get>get.hpp</a>
|
|
<a class=anchor href=#gethpp>#</a></h2><p><code>toml::value</code>の値を取り出し変換する<code>toml::get<T></code>関数を定義します。</p><h2 id=intohpp><a href=into>into.hpp</a>
|
|
<a class=anchor href=#intohpp>#</a></h2><p>ユーザー定義型を変換するための<code>into<T></code>型の前方宣言です。</p><h2 id=literalhpp><a href=literal>literal.hpp</a>
|
|
<a class=anchor href=#literalhpp>#</a></h2><p><code>operator"" _toml</code>リテラルを定義します。</p><h2 id=ordered_><a href=ordered_map>ordered_map.hpp</a>
|
|
<a class=anchor href=#ordered_>#</a></h2><p><code>toml::ordered_map</code>を定義します。</p><h2 id=parserhpp><a href=parser>parser.hpp</a>
|
|
<a class=anchor href=#parserhpp>#</a></h2><p>ファイルまたは文字列をパースする関数を定義します。</p><h2 id=resulthpp><a href=result>result.hpp</a>
|
|
<a class=anchor href=#resulthpp>#</a></h2><p>他の関数の返り値として使われる、成功値または失敗値を持つ<code>result<T, E></code>型を定義します。</p><h2 id=serializerhpp><a href=serializer>serializer.hpp</a>
|
|
<a class=anchor href=#serializerhpp>#</a></h2><p>シリアライズに用いる<code>toml::format</code>関数と<code>toml::serializer</code>を定義します。</p><h2 id=source_><a href=source_location>source_location.hpp</a>
|
|
<a class=anchor href=#source_>#</a></h2><p>エラー情報に用いられる、ファイル内のある領域を指す<code>source_location</code>型を定義します。</p><h2 id=spechpp><a href=spec>spec.hpp</a>
|
|
<a class=anchor href=#spechpp>#</a></h2><p>TOML言語のバージョン情報と機能フラグを制御する、<code>toml::semantic_version</code>型と<code>toml::spec</code>型を定義します。</p><h2 id=tomlhpp><a href=toml>toml.hpp</a>
|
|
<a class=anchor href=#tomlhpp>#</a></h2><p><code>toml.hpp</code>は、他の全てのヘッダを <code>include</code> します。
|
|
toml11の全機能が使用可能になります。</p><h2 id=toml_><a href=toml_fwd>toml_fwd.hpp</a>
|
|
<a class=anchor href=#toml_>#</a></h2><p><code>toml_fwd.hpp</code>は、toml11で定義される構造体の前方宣言と、マクロ定義を持ちます。</p><h2 id=typeshpp><a href=types>types.hpp</a>
|
|
<a class=anchor href=#typeshpp>#</a></h2><p><code>toml::value</code>の持つ型を制御するための<code>toml::type_config</code>型を定義します。</p><h2 id=valuehpp><a href=value>value.hpp</a>
|
|
<a class=anchor href=#valuehpp>#</a></h2><p><code>toml::value</code>型を定義します。</p><h2 id=value_><a href=value_t>value_t.hpp</a>
|
|
<a class=anchor href=#value_>#</a></h2><p>列挙型<code>toml::value_t</code>を定義します。</p><h2 id=versionhpp><a href=version>version.hpp</a>
|
|
<a class=anchor href=#versionhpp>#</a></h2><p>toml11のバージョン情報を定義します。</p><h2 id=visithpp><a href=visit>visit.hpp</a>
|
|
<a class=anchor href=#visithpp>#</a></h2><p><code>toml::value</code>の持つ値に関数を適用する<code>toml::visit</code>関数を定義します。</p><h2 id=備考>備考
|
|
<a class=anchor href=#%e5%82%99%e8%80%83>#</a></h2><p>ここで明記されない関数（主に<code>namespace toml::detail</code>や<code>namespace toml::cxx</code>以下に定義されるもの）は、
|
|
ソースコードを見ることで利用可能ではあるものの、そのインターフェースは今後のいかなるバージョンアップでも（パッチバージョンアップを含む）維持される保証はありません。</p></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=#reference>Reference</a><ul><li><a href=#ディレクトリ構造>ディレクトリ構造</a></li><li><a href=#colorhpp><a href=color>color.hpp</a></a></li><li><a href=#commentshpp><a href=comments>comments.hpp</a></a></li><li><a href=#conversionhpp><a href=conversion>conversion.hpp</a></a></li><li><a href=#datetimehpp><a href=datetime>datetime.hpp</a></a></li><li><a href=#error_><a href=error_info>error_info.hpp</a></a></li><li><a href=#exceptionhpp><a href=exception>exception.hpp</a></a></li><li><a href=#findhpp><a href=find>find.hpp</a></a></li><li><a href=#formathpp><a href=format>format.hpp</a></a></li><li><a href=#fromhpp><a href=from>from.hpp</a></a></li><li><a href=#gethpp><a href=get>get.hpp</a></a></li><li><a href=#intohpp><a href=into>into.hpp</a></a></li><li><a href=#literalhpp><a href=literal>literal.hpp</a></a></li><li><a href=#ordered_><a href=ordered_map>ordered_map.hpp</a></a></li><li><a href=#parserhpp><a href=parser>parser.hpp</a></a></li><li><a href=#resulthpp><a href=result>result.hpp</a></a></li><li><a href=#serializerhpp><a href=serializer>serializer.hpp</a></a></li><li><a href=#source_><a href=source_location>source_location.hpp</a></a></li><li><a href=#spechpp><a href=spec>spec.hpp</a></a></li><li><a href=#tomlhpp><a href=toml>toml.hpp</a></a></li><li><a href=#toml_><a href=toml_fwd>toml_fwd.hpp</a></a></li><li><a href=#typeshpp><a href=types>types.hpp</a></a></li><li><a href=#valuehpp><a href=value>value.hpp</a></a></li><li><a href=#value_><a href=value_t>value_t.hpp</a></a></li><li><a href=#versionhpp><a href=version>version.hpp</a></a></li><li><a href=#visithpp><a href=visit>visit.hpp</a></a></li><li><a href=#備考>備考</a></li></ul></li></ul></nav></div></aside></main></body></html> |