std::basic_format_string, std::format_string, std::wformat_string

ヘッダー `<format>` で定義
template< class CharT, class... Args > struct basic_format_string;	(1)	(C++20以降)
template< class... Args > using format_string = basic_format_string<char, std::type_identity_t<Args>...>;	(2)	(C++20以降)
template< class... Args > using wformat_string = basic_format_string<wchar_t, std::type_identity_t<Args>...>;	(3)	(C++20以降)

クラステンプレート std::basic_format_string は、書式化関数によって使用される std::basic_string_view をラップします。

std::basic_format_string のコンストラクタは、コンパイル時に書式指定文字列のチェックを実行します。ただし、コンストラクタ引数が std::runtime_format によって返される場合は除きます(C++26 以降)。

std::basic_format_string::basic_format_string

template< class T > consteval basic_format_string( const T& s );	(1)
basic_format_string( /* runtime-format-string */<CharT> s ) noexcept;	(2)	(C++26以降)

1) 文字列 s のビューを格納する basic_format_string オブジェクトを構築します。引数がコンパイル時定数でない場合、または書式化引数型 Args の書式指定文字列として解析できない場合、構築は不正です。

このオーバーロードは、const T& が std::convertible_to<std::basic_string_view<CharT>> をモデル化する場合にのみ、オーバーロード解決に参加します。

2) std::runtime_format によって返される文字列 s のビューを格納する basic_format_string オブジェクトを構築します。構築時に書式指定文字列のチェックは実行されません。

パラメータ

s

-

フォーマット文字列を表すオブジェクト。フォーマット文字列は以下で構成される：

通常の文字（{ と } を除く）は、変更されずに出力にコピーされる。
エスケープシーケンス {{ と }} は、それぞれ出力で { と } に置き換えられる。
置換フィールド。

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


`{` 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 特殊化によって決定される。

std::basic_format_string::get

constexpr std::basic_string_view<CharT> get() const noexcept;

格納されている文字列ビューを返します。

[編集] 備考

エイリアステンプレート format_string および wformat_string は、テンプレート引数推論を抑制するために std::type_identity_t を使用します。通常、これらが関数パラメータとして出現する場合、そのテンプレート引数は他の関数引数から推論されます。

template<class... Args>
std::string format(std::format_string<Args...> fmt, Args&&... args);
 
auto s = format("{} {}", 1.0, 2);
// Calls format<double, int>. Args are deduced from 1.0, 2
// Due to the use of type_identity_t in format_string, template argument deduction
// does not consider the type of the format string.

[編集] 例

[編集] 欠陥報告

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

DR	適用対象	公開された動作	正しい動作
P2508R1	C++20	この機能にはユーザーから見える名前がない	`basic_format_string`という名前が公開された

コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ

標準フォーマット指定
フォーマット関数
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)

(コンストラクタ)	`basic_format_string` を構築し、引数が書式指定文字列でない場合はコンパイルエラーを発生させます。 (public member function)
get	ラップされた文字列を返します。 (public member function)

cppreference.com

名前空間

変種

表示

操作