3.6 KiB
+++ title = "reference" type = "docs" weight = 3 bookCollapseSection = true +++
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
ファイルまたは文字列をパースする関数を定義します。
result.hpp
他の関数の返り値として使われる、成功値または失敗値を持つresult<T, E>型を定義します。
serializer.hpp
シリアライズに用いるtoml::format関数とtoml::serializerを定義します。
source_location.hpp
エラー情報に用いられる、ファイル内のある領域を指すsource_location型を定義します。
spec.hpp
TOML言語のバージョン情報と機能フラグを制御する、toml::semantic_version型とtoml::spec型を定義します。
toml.hpp
toml.hppは、他の全てのヘッダを include します。
toml11の全機能が使用可能になります。
toml_fwd.hpp
toml_fwd.hppは、toml11で定義される構造体の前方宣言と、マクロ定義を持ちます。
types.hpp
toml::valueの持つ型を制御するためのtoml::type_config型を定義します。
value.hpp
toml::value型を定義します。
value_t.hpp
列挙型toml::value_tを定義します。
version.hpp
toml11のバージョン情報を定義します。
visit.hpp
toml::valueの持つ値に関数を適用するtoml::visit関数を定義します。
備考
ここで明記されない関数（主にnamespace toml::detailやnamespace toml::cxx以下に定義されるもの）は、
ソースコードを見ることで利用可能ではあるものの、そのインターフェースは今後のいかなるバージョンアップでも（パッチバージョンアップを含む）維持される保証はありません。