std::basic_format_context

 

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 OutputIt, class CharT > class basic_format_context;	(1)	(C++20以降)
using format_context = basic_format_context</* 不明 */, char>;	(2)	(C++20以降)
using wformat_context = basic_format_context</* 不明 */, wchar_t>;	(3)	(C++20以降)

フォーマット引数と出力イテレータからなるフォーマット状態へのアクセスを提供します。

2) 不明なテンプレート引数は、std::string に追記する出力イテレータです。例えば std::back_insert_iterator<std::string> です。実装は通常、任意の連続的でリサイズ可能なコンテナへの追記をサポートする、型消去されたバッファ型へのイテレータを使用します。

3) 不明なテンプレート引数は、std::wstring に追記する出力イテレータです。

OutputIt が std::output_iterator<const CharT&> をモデル化しない場合、動作は未定義です。

std::basic_format_context の明示的または部分的な特殊化を宣言するプログラムは、診断なしで不正形式となります。

std::basic_format_context オブジェクトは、実装によってのみ作成できます。ユーザーコードは、std::formatter 特殊化の format 関数を通じてのみフォーマットコンテキストを変更することが許可されます。

メンバー型

型	定義
iterator	OutputIt
char_type	CharT

メンバーエイリアステンプレート

型	定義
formatter_type<T>	std::formatter<T, CharT>

メンバー関数

(コンストラクタ) [削除]	basic_format_context はユーザーコードで構築できません (public member function)
operator= [削除]	basic_format_context は代入できません (public member function)
arg	指定されたインデックスの引数を返します (public member function)
locale	ロケール固有のフォーマットに使用されるロケールを返します (public member function)
out	出力バッファへのイテレータを返します (public member function)
advance_to	出力イテレータを指定された位置に進めます (public member function)

std::basic_format_context::arg

std::basic_format_arg<basic_format_context> arg( std::size_t id ) const;

フォーマット関数に渡されたパラメータパックまたはstd::basic_format_argsオブジェクトであるargsのid番目の引数を保持するstd::basic_format_argを返します。

id がフォーマット引数の数より小さい場合、デフォルト構築された std::basic_format_arg（std::monostate オブジェクトを保持）を返します。

std::basic_format_context::locale

std::locale locale();

フォーマット関数に渡されたロケール、またはフォーマット関数がロケールを取らない場合はデフォルト構築された std::locale を返します。

std::basic_format_context::out

iterator out();

出力バッファへのイテレータを返します。結果は格納されているイテレータからムーブ構築されます。

std::basic_format_context::advance_to

void advance_to( iterator it );

格納されている出力イテレータに it をムーブ代入します。advance_to の呼び出し後、out() の次の呼び出しは、代入前の it の値を持つイテレータを返します。

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 3567	C++20	basic_format_context はムーブ専用イテレータ型で動作しません	ムーブイテレータに対応
LWG 3975	C++20	basic_format_context のユーザー定義特殊化が許可されていました	不許可になった
LWG 4061	C++20	basic_format_context はユーザーコードで構築・代入可能でした	構築も代入もできないように変更