Namespaces
Variants

std:: formatted_size

From cppreference.net
C++
Text processing library
Formatting library
Standard format specification
Formatting functions
(C++20)
(C++20)
(C++20)
formatted_size
(C++20)
(C++20)
(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 ... 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 (optional) } (1)
{ arg-id (optional) : format-spec } (2)
1) 不带格式说明的替换字段
2) 带格式说明的替换字段
arg-id - 指定 args 中参数的索引，其值将用于格式化；如果省略，则按顺序使用参数。

格式字符串中的 arg-id 必须全部显式指定或全部省略。混合手动和自动索引是错误的。

format-spec - 由对应参数的 std::formatter 特化定义的格式规范。不能以 } 开头。

(since C++23)
(since 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}; // "₀" 或 {0342, 130, 128}
    constexpr auto aprox_equ{"\N{APPROXIMATELY EQUAL TO}"sv}; // "≅" 或 {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 << '\n';
    // 使用 std::vector 作为动态缓冲区。缓冲区不包含结尾的 '\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 << "缓冲区: "
              << std::quoted(std::string_view{buffer.data(), min_buffer_size})
              << '\n';
    // 在添加结尾 '\0' 后直接打印缓冲区。
    buffer.push_back('\0');
    std::cout << "缓冲区: " << std::quoted(buffer.data()) << '\n';
}

输出： 

最小缓冲区大小 = 37
缓冲区: "Hubble's H₀ ≅ *42* miles/sec/mpc."
缓冲区: "Hubble's H₀ ≅ *42* miles/sec/mpc."

缺陷报告

以下行为变更缺陷报告被追溯应用于先前发布的C++标准。

缺陷报告 应用于 发布时行为 正确行为
P2216R3 C++20 对无效格式字符串抛出 std::format_error 无效格式字符串导致编译时错误
P2418R2 C++20 既非常量可用也非可复制的对象
（如生成器类对象）不可格式化 		允许格式化这些对象
P2508R1 C++20 该设施没有对用户可见的名称 公开 basic_format_string 名称

参见

(C++20)
通过输出迭代器写入其参数的格式化表示
(函数模板)
(C++20)
通过输出迭代器写入其参数的格式化表示，且不超过指定大小
(函数模板)