4. vformat_to

最終更新日時(UTC):
が更新

履歴 編集

function
<format>

std::vformat_to(C++20)

namespace std {
  template<class Out>
  Out vformat_to(Out out, string_view fmt, format_args args); // (1)

  template<class Out>
  Out vformat_to(Out out, wstring_view fmt, wformat_args args); // (2)

  template<class Out>
  Out vformat_to(Out out, const locale& loc, string_view fmt, format_args args); // (3)

  template<class Out>
  Out vformat_to(Out out, const locale& loc, wstring_view fmt, wformat_args args); // (4)
}

概要

書式文字列fmtに従ったフォーマットでargsの文字列表現を出力イテレータoutに出力する。

  • (1): マルチバイト文字列版
  • (2): ワイド文字列版
  • (3): マルチバイト文字列版 (ロケール指定あり)
  • (4): ワイド文字列版 (ロケール指定あり)

format_toのフォーマット引数を型消去したバージョンであり、内部的に使用される。文字列をフォーマットする目的で直接利用する必要はない。 ただし、format_toのような関数を自作する場合は、vformat_toを使って実装すると便利である。

テンプレートパラメータ制約

Outは以下の制約を満たす。

  • (1),(3): OutputIterator<const char&>
  • (2),(4): OutputIterator<const wchar_t&>

事前条件

outは以下の制約を満たす型の有効なオブジェクトである。

  • (1),(3): OutputIterator<const char&>
  • (2),(4): OutputIterator<const wchar_t&>

効果

書式文字列fmtに従ったフォーマットでargsの文字列表現を出力イテレータoutの[out, out + N)のイテレータ範囲に出力する。ロケールlocが指定された場合は、ロケール依存のフォーマットにおいて使用される。 (ただし、N=formatted_size(fmt, args...) または formatted_size(loc, fmt, args...))

戻り値

out + N (ただし、N=formatted_size(fmt, args...) または formatted_size(loc, fmt, args...))

例外

書式文字列が正しくなかったり、フォーマット実行時に失敗したりした場合、format_errorを投げる。

バージョン

言語

  • C++20

処理系

参照