std::formatted_size

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名需求

功能测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

实用程序库

语言支持 类型支持 (基本类型，RTTI) 库功能测试宏 (C++20) 动态内存管理 程序实用程序 协程支持 (C++20) 可变参数函数 is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) 调试支持 is_debugger_present (C++26) breakpoint_if_debugging (C++26) breakpoint (C++26) 三路比较 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_ltis_lteq (C++20)(C++20)(C++20) is_neqis_gtis_gteq (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 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)

格式字符串

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

如果对于 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 s 必须全部存在或全部省略。混合手动和自动索引是错误的。 format-spec - 由对应参数的 std::formatter 特性定义的格式规范。不能以 } 开头。 对于基本类型和标准字符串类型，格式规范被解释为 标准格式规范。 对于 chrono 类型，格式规范被解释为 chrono 格式规范。 对于范围类型，格式规范被解释为 范围格式规范。 对于 std::pair 和 std::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	既不是常量可使用也不是可复制的对象 (例如生成器类对象) 不可格式化	允许格式化这些对象
P2508R1	C++20	此工具没有用户可见的名称	公开名称 basic_format_string

另请参阅

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