std::basic_format_arg<Context>::handle

 

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<Context>::handle;		(C++20以降)

ユーザー定義型のオブジェクトのフォーマットを可能にする、型消去されたラッパー。

handle オブジェクトは通常、std::make_format_args によって作成され、std::visit_format_arg または std::basic_format_arg の visit メンバ関数からアクセスされます（C++26以降）。

データメンバ

handle の典型的な実装は TriviallyCopyable であり、2つの非静的データメンバのみを格納します。

• フォーマットされるオブジェクトへの const void* ポインタ、および
• format メンバ関数で必要な操作を実行する関数への void (*)(std::basic_format_parse_context<Context::char_type>&, Context&, const void*) 関数ポインタ（後述）。

メンバ関数

format (C++20)

参照されているオブジェクトを指定されたコンテキストでフォーマットします。 (public member function)

std::basic_format_arg<Context>::handle::format

void format( std::basic_format_parse_context<Context::char_type>& parse_ctx,              Context& format_ctx ) const;		(C++20以降)

以下とする:

• フォーマット引数の型を T とします。
• TD は std::remove_const_t<T> とします。
• TQ は、const TD が __formattable_with<Context> を満たす場合は const TD、そうでない場合は TD とします。
• ref はフォーマット引数への参照とします。

等価な処理： typename Context::template formatter_type<TD> f;
parse_ctx.advance_to(f.parse(parse_ctx));
format_ctx.advance_to(f.format(const_cast<TQ&>(static_cast<const TD&>(ref)), format_ctx));

注釈

handle はフォーマットされる引数に対して参照セマンティクスを持ち、そのライフタイムを延長しません。引数が handle よりも長く生存することを保証するのはプログラマの責任です。通常、handle はフォーマット関数内でのみ使用されます。

関連項目

basic_format_arg (C++20)	ユーザー定義フォーマッタのためにフォーマット引数へのアクセスを提供するクラステンプレート (クラステンプレート)
make_format_argsmake_wformat_args (C++20)(C++20)	format_args に変換可能な、すべてのフォーマット引数を参照する型消去されたオブジェクトを作成する (関数テンプレート)