std::formatted_size

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持（基本类型、 RTTI） 库功能特性测试宏 (C++20) 动态内存管理 程序工具 协程支持 (C++20) 变参数函数 is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) 三路比较 (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20) is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

通用工具 日期和时间 函数对象 格式化库 (C++20) bitset hash (C++11) 关系运算符 (C++20 中弃用) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= 整数比较函数 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20) cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) swap 与类型运算 swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) 常用词汇类型 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

格式化库

格式化函数

format (C++20)

format_to (C++20)

format_to_n (C++20)

formatted_size (C++20)

vformat (C++20)

vformat_to (C++20)

格式化概念

formattable (C++23)

格式化器

formatter (C++20)

range_formatter (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)

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

确定按照格式字符串 fmt 格式化 args 得到的有格式字符串的总字符数。 loc 若存在则用于本地环境特定的格式化。

若对 Args 中任何 Ti ， std::formatter<Ti, CharT> 不满足格式化器 (Formatter) 要求则行为未定义。

参数

fmt	-	未指定类型的形参，其初始化仅若实参可转换成 std::string_view （对于 (1,3) ）或 std::wstring_view （对于 (2,4) ），而转换结果是常量表达式和 Args 的合法格式字符串才合法。格式字符串由以下内容组成： 通常字符（除了 { 与 } ），它们被不加修改地复制到输出， 转义序列 {{ 与 }} ，它们在输出中被分别替换成 { 与 } ，以及 替换域。 每个替换域拥有下列格式： 引入的 { 字符； (可选) arg-id ，一个非负数； (可选) 冒号（ : ）后随格式说明； 终止的 } 字符。 arg-id 指定用于格式化其值的 args 中的参数的下标；若省略 arg-id ，则按顺序使用参数。格式字符串中的 arg-id 必须全部存在或全部被省略。混合手动和自动指定下标是错误。 格式说明由对应参数特化的 std::formatter 定义。 对于基本类型和标准字符串类型，格式说明为标准格式说明； 对于标准日期和时间类型，格式说明为 chrono 格式说明； 对于用户定义类型，格式说明由用户定义的 std::formatter 特化决定。
args...	-	要格式化的参数
loc	-	用于本地环境特定的格式化的 std::locale

返回值

有格式字符串中的总字符数。

异常

传播格式化器所抛的任何异常。

示例

运行此代码

#include <format>
#include <iostream>
#include <vector>
#include <string_view>
 
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 { "₀"sv };  // { "\u2080"sv } => { 0xe2, 0x82, 0x80 };
    constexpr auto aprox_equ { "≅"sv }; // { "\u2245"sv } => { 0xe2, 0x89, 0x85 };
    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';
 
    // 以 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 << "Buffer: \"" << std::string_view{buffer.data(), min_buffer_size} << "\"\n";
 
    // 或者我们能通过添加尾随 '\0' 直接打印缓冲区。
    buffer.push_back('\0');
    std::cout << "Buffer: \"" << buffer.data() << "\"\n";
}

输出：

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

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告	应用于	出版时的行为	正确行为
P2216R3	C++20	对非法格式字符串抛出 std::format_error	非法格式字符串导致编译时错误

参阅

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