std::basic_format_arg

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

テキスト処理ライブラリ

ローカライズライブラリ

正規表現ライブラリ (C++11)

フォーマットライブラリ (C++20)

ヌル終端シーケンスユーティリティ

バイト文字列

マルチバイト文字列

ワイド文字列

プリミティブな数値変換

to_chars (C++17) to_chars_result (C++17) from_chars (C++17) from_chars_result (C++17) chars_format (C++17)

テキストエンコーディング識別

text_encoding (C++26)

 

書式設定ライブラリ

標準フォーマット指定

フォーマット関数

format (C++20)

format_to (C++20)

format_to_n (C++20)

formatted_size (C++20)

vformat (C++20)

vformat_to (C++20)

フォーマット文字列

basic_format_stringformat_stringwformat_string (C++20)(C++20)(C++20)

runtime_format (C++26)

フォーマット関連コンセプト

formattable (C++23)

フォーマッタ

formatter (C++20)

formatter<pair-or-tuple> (C++23)

formatter<range> (C++23)

range_formatter (C++23)

enable_nonlocking_formatter_optimization (C++23)

basic_format_parse_contextformat_parse_contextwformat_parse_context (C++20)(C++20)(C++20)

basic_format_contextformat_contextwformat_context (C++20)(C++20)(C++20)

range_format (C++23)

format_kind (C++23)

フォーマット引数

basic_format_arg (C++20)

basic_format_arg::handle (C++20)

basic_format_argsformat_argswformat_args (C++20)(C++20)(C++20)

visit_format_arg (C++20) (C++26で非推奨)

make_format_argsmake_wformat_args (C++20)(C++20)

フォーマットエラー

format_error (C++20)

 

ヘッダー <format> で定義
template< class Context > class basic_format_arg;		(C++20以降)

書式設定引数へのアクセスを提供します。

basic_format_arg オブジェクトは通常 std::make_format_args によって作成され、std::visit_format_arg または visit メンバ関数(C++26 以降) を介してアクセスされます。

basic_format_arg オブジェクトは、以下の型の std::variant を格納しているかのように動作します。

• std::monostate (オブジェクトがデフォルト構築された場合のみ)
• bool
• Context::char_type
• int
• unsigned int
• long long int
• unsigned long long int
• float
• double
• long double
• const Context::char_type*
• std::basic_string_view<Context::char_type>
• const void*
• basic_format_arg::handle

メンバクラス

handle (C++20)

ユーザー定義型のオブジェクトの書式設定を可能にする型消去ラッパー (public メンバクラス)

メンバ関数

(コンストラクタ) (C++20)	std::basic_format_arg を構築します (public member function)
operator bool (C++20)	現在のオブジェクトが書式設定引数を保持しているかチェックします (public member function)
visit (C++26)	格納されている書式設定引数を訪問します (public member function)

非メンバ関数

visit_format_arg (C++20) (C++26で非推奨)

ユーザー定義フォーマッタのための引数訪問インターフェース (関数テンプレート)

std::basic_format_arg::basic_format_arg

basic_format_arg() noexcept;		(C++20以降)

デフォルトコンストラクタ。書式設定引数を保持しない basic_format_arg を構築します。格納されているオブジェクトは std::monostate 型です。

書式設定引数を保持する basic_format_arg を作成するには、std::make_format_args を使用する必要があります。

std::basic_format_arg::operator bool

explicit operator bool() const noexcept;		(C++20以降)

*this が書式設定引数を保持しているかチェックします。

*this が書式設定引数を保持している場合（つまり、格納されているオブジェクトが std::monostate 型でない場合）は true を返し、それ以外の場合は false を返します。

std::basic_format_arg::visit

template< class Visitor > decltype(auto) visit( this basic_format_arg arg, Visitor&& vis );	(1)	(C++26以降)
template< class R, class Visitor > R visit( this basic_format_arg arg, Visitor&& vis );	(2)	(C++26以降)

vis を arg に含まれるオブジェクトに適用します。

visit 関数は、呼び出し時にオブジェクトのコピーが使用されるため、呼び出された basic_format_arg オブジェクトを変更しません。

1) return std::visit(std::forward<Visitor>(vis), v); と等価です。ここで v は arg に格納されている std::variant です。

2) return std::visit<R>(std::forward<Visitor>(vis), v); と等価です。ここで v は arg に格納されている std::variant です。

備考

機能テストマクロ	値	規格	機能
__cpp_lib_format	202306L	(C++26)	メンバ visit

参照

basic_format_argsformat_argswformat_args (C++20)(C++20)(C++20)

すべてのフォーマット引数へのアクセスを提供するクラス (クラステンプレート)