std::basic_format_context

 

C++

言語

標準ライブラリヘッダ

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

名前付き要件

言語サポートライブラリ

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

診断ライブラリ

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

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ (C++20)

アルゴリズムライブラリ

数値演算ライブラリ

ローカライゼーションライブラリ

入出力ライブラリ

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

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

アトミック操作ライブラリ (C++11)

スレッドサポートライブラリ (C++11)

技術仕様書

 

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

言語サポート 型サポート (基本型、RTTI、型特性) ライブラリの機能テストマクロ (C++20) 動的メモリ管理 プログラムユーティリティ エラー処理 コルーチンサポート (C++20) 可変長引数関数 launder (C++17) initializer_list (C++11) source_location (C++20) 三方比較 (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20) is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

汎用ユーティリティ 日付と時間 関数オブジェクト 書式化ライブラリ (C++20) bitset hash (C++11) integer_sequence (C++14) 関係演算子 (C++20で非推奨) rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>= 整数比較関数 cmp_equalcmp_not_equalcmp_lesscmp_greatercmp_less_thancmp_greater_than (C++20)(C++20)(C++20)(C++20)(C++20)(C++20) in_range (C++20) スワップと型操作 swap ranges::swap (C++20) exchange (C++14) declval (C++11) forward (C++11) move (C++11) move_if_noexcept (C++11) as_const (C++17) 一般的な語彙の型 pair tuple (C++11) apply (C++17) make_from_tuple (C++17) optional (C++17) any (C++17) variant (C++17) 初等文字列変換 to_chars (C++17) from_chars (C++17) chars_format (C++17)

 

書式化ライブラリ

書式化関数

format (C++20)

format_to (C++20)

format_to_n (C++20)

formatted_size (C++20)

vformat (C++20)

vformat_to (C++20)

フォーマッタ

formatter (C++20)

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)

書式化引数

basic_format_arg (C++20)

basic_format_argsformat_argswformat_argsformat_args_t (C++20)(C++20)(C++20)(C++20)

visit_format_arg (C++20)

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

書式化エラー

format_error (C++20)

 

<tbody> </tbody>

ヘッダ <format> で定義
template<class OutputIt, class CharT> class basic_format_context;	(1)	(C++20以上)
using format_context = basic_format_context</* unspecified */, char>;	(2)	(C++20以上)
using wformat_context = basic_format_context</* unspecified */, wchar_t>;	(3)	(C++20以上)

書式化引数および出力イテレータから構成される書式化状態へのアクセスを提供します。

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

2) 未規定のテンプレート引数は std::back_insert_iterator<std::string> などの std::string への追加を行う出力イテレータです。 処理系は任意の隣接したサイズ可変のコンテナへの追加をサポートする型消去されたバッファ型へのイテレータを使用することが推奨されます。

3) 未規定のテンプレート引数は std::wstring への追加を行う出力イテレータです。

メンバ型

型	定義
iterator	OutputIt
char_type	CharT

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

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

メンバ関数

arg	指定されたインデックスの引数を返します。 (パブリックメンバ関数)
locale	ロケール固有の書式化のために使用するロケールを返します。 (パブリックメンバ関数)
out	出力バッファへのイテレータを返します。 (パブリックメンバ関数)
advance_to	出力イテレータを指定された位置まで前進させます。 (パブリックメンバ関数)

std::basic_format_context::arg

<tbody> </tbody>

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

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

id が書式化引数の数より小さくない場合は、デフォルト構築された std::basic_format_arg (std::monostate オブジェクトを保持します) を返します。

std::basic_format_context::locale

<tbody> </tbody>

std::locale locale();

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

std::basic_format_context::out

<tbody> </tbody>

iterator out();

出力バッファへのイテレータを返します。

std::basic_format_context::advance_to

<tbody> </tbody>

void advance_to(iterator it);

出力イテレータを it に設定します。 advance_to の呼び出しの後に out() を呼び出すと it のコピーを返します。