std::vformat_to

 

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 > OutputIt vformat_to( OutputIt out, std::string_view fmt, std::format_args args );	(1)	(C++20以降)
template< class OutputIt > OutputIt vformat_to( OutputIt out, std::wstring_view fmt, std::wformat_args args );	(2)	(C++20以降)
template< class OutputIt > OutputIt vformat_to( OutputIt out, const std::locale& loc,                      std::string_view fmt, std::format_args args );	(3)	(C++20以降)
template< class OutputIt > OutputIt vformat_to( OutputIt out, const std::locale& loc,                      std::wstring_view fmt, std::wformat_args args );	(4)	(C++20以降)

フォーマット文字列fmtに従ってargsで保持されているフォーマット引数をフォーマットし、結果を出力イテレータoutに書き込みます。locが存在する場合は、ロケール固有のフォーマットに使用されます。

CharTをdecltype(fmt)::char_type（オーバーロード(1,3)の場合はchar、オーバーロード(2,4)の場合はwchar_t）とします。

これらのオーバーロードは、OutputItがコンセプトstd::output_iterator<const CharT&>を満たす場合にのみオーバーロード解決に参加します。

OutputItはコンセプトstd::output_iterator<const CharT&>をモデル化（意味的要件を満たす）する必要があり、また、引数の型における任意のTiに対してstd::formatter<Ti, CharT>がFormatter要件を満たす必要があります。それ以外の場合は、動作は未定義です。

パラメータ

out	-	出力バッファへのイテレータ
fmt	-	フォーマット文字列を表すオブジェクト。フォーマット文字列は以下で構成される： 通常の文字（{ と } を除く）は、変更されずに出力にコピーされる。 エスケープシーケンス {{ と }} は、それぞれ出力で { と } に置き換えられる。 置換フィールド。 各置換フィールドは以下の形式を持つ。 { arg-id (オプション) } (1) { arg-id (オプション) : format-spec } (2) 1) フォーマット指定なしの置換フィールド 2) フォーマット指定ありの置換フィールド arg-id - フォーマットに使用する args 内の引数のインデックスを指定する。省略された場合、引数は順番に使用される。 フォーマット文字列内の arg-id は、すべて存在するか、すべて省略されなければならない。手動と自動のインデックス付けを混在させることはエラーである。 format-spec - 対応する引数に対する std::formatter 特殊化によって定義されるフォーマット指定。} で開始することはできない。 基本型および標準文字列型の場合、フォーマット指定は標準フォーマット指定として解釈される。 chrono型の場合、フォーマット指定はchronoフォーマット指定として解釈される。 範囲型の場合、フォーマット指定は範囲フォーマット指定として解釈される。 std::pair および std::tuple の場合、フォーマット指定はtupleフォーマット指定として解釈される。 std::thread::id および std::stacktrace_entry の場合、スレッドIDフォーマット指定およびスタックトレースエントリフォーマット指定を参照。 std::basic_stacktrace の場合、フォーマット指定子は許可されない。 (C++23から) std::filesystem::path の場合、パスフォーマット指定を参照。 (C++26以降) その他のフォーマット可能な型の場合、フォーマット指定はユーザー定義の formatter 特殊化によって決定される。
args	-	フォーマットする引数
loc	-	ロケール固有のフォーマットに使用される std::locale

戻り値

出力範囲の終端の次のイテレータ。

例外

fmtが提供された引数に対して有効なフォーマット文字列でない場合、std::format_errorを送出します。また、フォーマッタまたはイテレータ操作によって送出された例外を伝播します。

不具合報告

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

DR	適用対象	公開された動作	正しい動作
P2216R3	C++20	argsの型はOutputItでパラメータ化されています。	パラメータ化されていません。