std::formatted_size

 

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... Args > std::size_t formatted_size( std::format_string<Args...> fmt, Args&&... args );	(1)	(C++20以降)
template< class... Args > std::size_t formatted_size( std::wformat_string<Args...> fmt, Args&&... args );	(2)	(C++20以降)
template< class... Args > std::size_t formatted_size( const std::locale& loc,                             std::format_string<Args...> fmt, Args&&... args );	(3)	(C++20以降)
template< class... Args > std::size_t formatted_size( const std::locale& loc,                             std::wformat_string<Args...> fmt, Args&&... args );	(4)	(C++20以降)

フォーマット文字列 fmt に従って引数 args をフォーマットし、フォーマットされた文字列の総文字数を決定します。指定されている場合、loc はロケール固有のフォーマットに使用されます。

Args の任意の Ti について、std::formatter<std::remove_cvref_t<Ti>, CharT> が BasicFormatter の要件を満たさない場合、動作は未定義です。

パラメータ

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

戻り値

フォーマットされた文字列の総文字数。

例外

フォーマッタによってスローされた例外を伝播します。

例

このコードを実行

#include <format>
#include <iomanip>
#include <iostream>
#include <string_view>
#include <vector>
 
int main()
{
    using namespace std::literals::string_view_literals;
 
    constexpr auto fmt_str{"Hubble's H{0} {1} {2:*^4} miles/sec/mpc."sv};
    constexpr auto sub_zero{"\N{SUBSCRIPT ZERO}"sv}; // "₀" or {0342, 130, 128}
    constexpr auto aprox_equ{"\N{APPROXIMATELY EQUAL TO}"sv}; // "≅" or {0342, 137, 133}
    constexpr int Ho{42}; // H₀
 
    const auto min_buffer_size{std::formatted_size(fmt_str, sub_zero, aprox_equ, Ho)};
    std::cout << "Min buffer size = " << min_buffer_size << '\n';
 
    // Use std::vector as dynamic buffer. The buffer does not include the trailing '\0'.
    std::vector<char> buffer(min_buffer_size);
 
    std::format_to_n(buffer.data(), buffer.size(), fmt_str, sub_zero, aprox_equ, Ho);
    std::cout << "Buffer: "
              << std::quoted(std::string_view{buffer.data(), min_buffer_size})
              << '\n';
 
    // Print the buffer directly after adding the trailing '\0'.
    buffer.push_back('\0');
    std::cout << "Buffer: " << std::quoted(buffer.data()) << '\n';
}

出力

Min buffer size = 37
Buffer: "Hubble's H₀ ≅ *42* miles/sec/mpc."
Buffer: "Hubble's H₀ ≅ *42* miles/sec/mpc."

不具合報告

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

DR	適用対象	公開された動作	正しい動作
P2216R3	C++20	無効なフォーマット文字列に対して std::format_error をスローします。	無効なフォーマット文字列はコンパイル時エラーになります。
P2418R2	C++20	const-usableでもコピー可能でもないオブジェクト （ジェネレータのようなオブジェクトなど）はフォーマットできない	これらのオブジェクトのフォーマットを許可する
P2508R1	C++20	この機能にはユーザーから見える名前がない	basic_format_stringという名前が公開された

関連項目

format_to (C++20)	引数のフォーマット済み表現を出力イテレータを介して書き出す (関数テンプレート)
format_to_n (C++20)	指定されたサイズを超えないように、引数のフォーマット済み表現を出力イテレータを介して書き出す (関数テンプレート)