std::formatted_size

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

文本处理库

本地化库

正则表达式库 (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

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，则用于特定于区域设置的格式化。

如果 std::formatter<std::remove_cvref_t<Ti>, CharT> 不满足 Args 中任何 Ti 的 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 可用也不是可复制的对象 （例如类似生成器的对象）不可格式化	允许格式化这些对象
P2508R1	C++20	此功能没有用户可见的名称	名称 basic_format_string 已公开

参见

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