std::format

 

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) 调试支持 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 (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::string format( std::format_string<Args...> fmt, Args&&... args );	(1)	(C++20 起)
template< class... Args > std::wstring format( std::wformat_string<Args...> fmt, Args&&... args );	(2)	(C++20 起)
template< class... Args > std::string format( const std::locale& loc,                     std::format_string<Args...> fmt, Args&&... args );	(3)	(C++20 起)
template< class... Args > std::wstring format( const std::locale& loc,                      std::wformat_string<Args...> fmt, Args&&... args );	(4)	(C++20 起)

按照格式字符串 fmt 格式化 args，并返回作为字符串的结果。若存在 loc，则它用于本地环境特定的格式化。

1) 等价于 return std::vformat(fmt.get(), std::make_format_args(args...));。

2) 等价于 return std::vformat(fmt.get(), std::make_wformat_args(args...));。

3) 等价于 return std::vformat(loc, fmt.get(), std::make_format_args(args...));。

4) 等价于 return std::vformat(loc, fmt.get(), std::make_wformat_args(args...));。

从 P2216R3 起，std::format 会对格式字符串进行编译时检查（通过辅助类型 std::format_string 或 std::wformat_string）。如果发现格式字符串与要格式化的实参类型不匹配，则会发出编译错误。如果格式字符串不能作为编译时常量，或者需要避免编译时检查，请使用 std::vformat 或 fmt 上的 std::runtime_format (C++26 起)代替。

以下要求适用于 Args 中的每个类型 T，其中 CharT 对于重载 (1,3) 是 char，对于重载 (2,4) 是 wchar_t：

• std::formatter<T, CharT> 必须满足 基本格式化器 (BasicFormatter)
• std::formatter<T, CharT>::parse() 在 P2216R3 起必须为 constexpr（std::vformat 不要求这点）

参数

fmt	-	用于表示格式字符串的对象。格式字符串由以下组成 通常字符（除了 { 与 }），它们被不加修改地复制到输出， 转义序列 {{ 与 }} ，它们在输出中被分别替换成 { 与 } ，以及 替换域。 每个替换域拥有如下格式： { 实参索引 (可选) } (1) { 实参索引 (可选) : 格式说明 } (2) 1) 没有格式说明的替换域 2) 有格式说明的替换域 实参索引 - 指定用于格式化它的值的 args 中的参数的下标；如果省略实参索引，那么按顺序使用参数。 格式字符串中的实参索引 必须全部存在或全部被省略。混合手动和自动指定下标是错误。 格式说明 - 格式说明由对应参数特化的 std::formatter 定义。不能以 } 开始。 对于基本类型和标准字符串类型，格式说明为标准格式说明。 对于 chrono 类型，格式说明为 chrono 格式说明。 对于范围类型，格式说明为范围格式说明。 对于 std::pair 和 std::tuple，格式说明为 tuple 格式说明。 对于 std::thread::id 和 std::stacktrace_entry，见 thread id 格式说明和 stacktrace entry 格式说明。 对于 std::basic_stacktrace，不允许使用格式说明符。 (C++23 起) 对于 std::filesystem::path，见路径格式说明。 (C++26 起) 对于其他可格式化类型，格式说明由用户定义的 std::formatter 特化决定。
args...	-	要格式化的实参
loc	-	用于本地环境特定格式化的 std::locale

返回值

保有格式化结果的字符串对象。

异常

在分配失败时抛出 std::bad_alloc。并且会传播格式化器所抛的任何异常。

注解

提供多于格式字符串所要求的实参不是错误：

std::format("{} {}!", "Hello", "world", "something"); // OK，产生 "Hello world!"

自 P2216R3 起，格式字符串不是常量表达式是错误。此情况下可使用 std::vformat。

std::string f(std::string_view runtime_format_string)
{
    // return std::format(runtime_format_string, "foo", "bar"); // 错误
    return std::vformat(runtime_format_string, std::make_format_args("foo", "bar")); // OK
}

可以直接在 std::format 上使用 std::runtime_format，代替要求以 std::basic_format_args 为实参的 std::vformat。 std::string f(std::string_view runtime_format_string) { return std::format(std::runtime_format(runtime_format_string), "foo", "bar"); }

(C++26 起)

示例

运行此代码

#include <format>
#include <iostream>
#include <string>
#include <string_view>
 
template <typename... Args>
std::string dyna_print(std::string_view rt_fmt_str, Args&&... args)
{
    return std::vformat(rt_fmt_str, std::make_format_args(args...));
}
 
int main()
{
    std::cout << std::format("Hello {}!\n", "world");
 
    std::string fmt;
    for (int i{}; i != 3; ++i)
    {
        fmt += "{} "; // 构造格式化字符串
        std::cout << fmt << " : ";
        std::cout << dyna_print(fmt, "alpha", 'Z', 3.14, "unused");
        std::cout << '\n';
    }
}

输出：

Hello world!
{}  : alpha 
{} {}  : alpha Z 
{} {} {}  : alpha Z 3.14

缺陷报告

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

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

参阅

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