Namespaces
Variants

std:: vformat_to

From cppreference.net
C++
Text processing library
Formatting library
Standard format specification
Formatting functions
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
vformat_to
(C++20)
Format strings
(C++20) (C++20) (C++20)
(C++26)
Formatting concepts
(C++23)
Formatter
(C++20)
(C++23)
(C++23)
(C++23)
(C++23)
(C++20) (C++20) (C++20)
(C++20) (C++20) (C++20)
(C++23)
(C++23)
Formatting arguments
(C++20)
(C++20)
(C++20) (C++20) (C++20)
(C++20) (deprecated in C++26)
(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以降)

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

CharT を decltype ( fmt ) :: char_type とする ( char はオーバーロード (1,3) 用、 wchar_t はオーバーロード (2,4) 用)。

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

OutputIt は概念 std:: output_iterator < const CharT & > の要件を満たさなければならず、かつ std:: formatter < Ti, CharT > は引数の型に含まれるあらゆる Ti に対して Formatter 要件を満たさなければなりません。これらの条件が満たされない場合、動作は未定義です。

目次

パラメータ

out - 出力バッファへのイテレータ
fmt - フォーマット文字列を表すオブジェクト。フォーマット文字列は以下から構成される：
  • 通常の文字（ { と } を除く）は変更されずに出力にコピーされる
  • エスケープシーケンス { { と } } は、出力でそれぞれ { と } に置き換えられる
  • 置換フィールド

各置換フィールドは以下の形式を持つ：

{ arg-id (optional) } (1)
{ arg-id (optional) : format-spec } (2)
1) フォーマット指定なしの置換フィールド
2) フォーマット指定ありの置換フィールド
arg-id - フォーマットに使用する args 内の引数のインデックスを指定する。省略された場合、引数は順番に使用される。

フォーマット文字列内の arg-id はすべて存在するか、すべて省略されなければならない。手動インデックスと自動インデックスの混合はエラーである。

format-spec - 対応する引数に対する std::formatter 特殊化によって定義されるフォーマット仕様。 } で始まることはできない。

(C++23以降)
(C++26以降)
  • その他のフォーマット可能な型の場合、フォーマット仕様はユーザー定義の formatter 特殊化によって決定される。
args - フォーマットされる引数
loc - ロケール固有のフォーマットに使用される std::locale

戻り値

出力範囲の終端を超えたイテレータ。

例外

指定された引数に対して std::format_error をスローする（ fmt が有効なフォーマット文字列でない場合）。また、フォーマッタまたはイテレータ操作でスローされた例外を伝播する。

例

このセクションは不完全です
理由: 例がありません

欠陥報告

以下の動作変更の欠陥報告書は、以前に公開されたC++規格に対して遡及的に適用されました。

DR 適用対象 公開時の動作 正しい動作
P2216R3 C++20 args の型は OutputIt に対してパラメータ化されている パラメータ化されていない

関連項目