std::formatter<pair-or-tuple>

 

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 CharT, std::formattable<CharT>... Ts > struct formatter</*pair-or-tuple*/<Ts...>, CharT>;		(C++23から)

std::formatter のテンプレート特殊化である std::pair および std::tuple 用のものは、ユーザーがペアまたはタプルを フォーマット関数 を使用して、要素のコレクションとしてのテキスト表現に変換することを可能にします。

公開専用名 /*pair-or-tuple*/ は、クラステンプレート std::pair または std::tuple のいずれかを示します。

この特殊化は、 (std::formattable<const Ts, CharT> && ...) が true である場合、 Formatter 要件を満たします。常に BasicFormatter 要件を満たします。

フォーマット仕様

tuple-format-spec の構文は次のとおりです。

tuple-fill-and-align (省略可能) width (省略可能) tuple-type (省略可能)

tuple-fill-and-align は、 fill が {、}、または : 以外の文字である場合を除き、 fill-and-align と同じように解釈されます。

width は、 標準フォーマット幅仕様 で説明されています。

tuple-type は、タプルのフォーマット方法を変更し、特定のオプションは特定の引数型でのみ有効です。

利用可能なタプルプレゼンテーション型は次のとおりです。

• m: 開始と終了のブラケットの両方が "" で、セパレータが ": " であることを示します。

• m が tuple-type として選択された場合、 sizeof...(Ts) = 2 が true でない限り、プログラムは不正形式になります。

• n: セパレータ、開始および終了ブラケットが "" であることを示します。

メンバオブジェクト

メンバ名	定義
underlying_ (private)	型 std::tuple<std::formatter<std::remove_cvref_t<Ts>, CharT>...> の基底フォーマッタのタプル (説明用のメンバオブジェクト*)
separator_ (private)	タプルフォーマット結果のセパレータを表す文字列 (デフォルトは ", ") (説明用のメンバオブジェクト*)
opening-bracket_ (private)	タプルフォーマット結果の開始ブラケットを表す文字列 (デフォルトは "(") (説明用のメンバオブジェクト*)
closing-bracket_ (private)	タプルフォーマット結果の終了ブラケットを表す文字列 (デフォルトは ")") (説明用のメンバオブジェクト*)

メンバ関数

set_separator	指定されたセパレータをタプルフォーマット結果に設定します。 (public member function)
set_brackets	指定された開始および終了ブラケットをタプルフォーマット結果に設定します。 (public member function)
parse	tuple-format-spec によって指定されたフォーマット指定子を解析します。 (public member function)
format	tuple-format-spec によって指定されたタプルフォーマット出力を書き込みます。 (public member function)

std::formatter<pair-or-tuple>::set_separator

constexpr void set_separator( std::basic_string_view<CharT> sep ) noexcept;

sep を separator_ に代入します。

std::formatter<pair-or-tuple>::set_brackets

constexpr void set_brackets( std::basic_string_view<CharT> opening,                              std::basic_string_view<CharT> closing ) noexcept;

opening と closing を、それぞれ opening-bracket_ と closing-bracket_ に代入します。

std::formatter<pair-or-tuple>::parse

template< class ParseContext > constexpr auto parse( ParseContext& ctx ) -> ParseContext::iterator;

tuple-format-spec としてフォーマット指定子を解析し、解析された指定子を現在のオブジェクトに格納します。

tuple-type または n オプションが存在する場合、 opening-bracket、 closing-bracket、および separator の値が必要に応じて変更されます。

underlying_ の各要素 e について、 e.parse(ctx) を呼び出して空の format-spec を解析し、 e.set_debug_format() が有効な式である場合は、 e.set_debug_format() を呼び出します。

tuple-format-spec の末尾以降のイテレータを返します。

std::formatter<pair-or-tuple>::format

template< class FormatContext > FormatContext::iterator format( /*maybe-const-pair-or-tuple*/<Ts...>& elems, FormatContext& ctx ) const;

/*maybe-const-pair-or-tuple*/ は以下を示します。

• const /*pair-or-tuple*/、 (std::formattable<const Ts, CharT> && ...) が true の場合。
• /*pair-or-tuple*/ それ以外の場合。

以下を ctx.out() に tuple-format-spec に従って、順番に書き込みます。

• opening-bracket_,
• インデックス I が [​0​, sizeof...(Ts)) の範囲にある場合

• もし I != 0 なら、 separator_。
• std::get<I>(elems) を std::get<I>(underlying_) 経由で書き込んだ結果。

• closing-bracket_.

出力範囲の末尾以降のイテレータを返します。

不具合報告

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

DR	適用対象	公開された動作	正しい動作
LWG 3892	C++23	ネストされたタプルのフォーマットが正しくありませんでした。	修正済み

関連項目

formatter (C++20)

与えられた型のフォーマット規則を定義する (クラステンプレート)