std::basic_format_string, std::format_string, std::wformat_string

 

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 CharT, class... Args > struct basic_format_string;	(1)	(自 C++20 起)
template< class... Args > using format_string =     basic_format_string<char, std::type_identity_t<Args>...>;	(2)	(自 C++20 起)
template< class... Args > using wformat_string =     basic_format_string<wchar_t, std::type_identity_t<Args>...>;	(3)	(自 C++20 起)

类模板 std::basic_format_string 封装了一个 std::basic_string_view，它将被格式化函数使用。

std::basic_format_string 的构造函数执行编译时格式字符串检查，除非构造函数参数由 std::runtime_format 返回(自 C++26 起)。

成员函数

(构造函数)	构造一个 basic_format_string，如果参数不是格式字符串，则引发编译错误 (公共成员函数)
get	返回封装的字符串 (公共成员函数)

std::basic_format_string::basic_format_string

template< class T > consteval basic_format_string( const T& s );	(1)
basic_format_string( /* runtime-format-string */<CharT> s ) noexcept;	(2)	(自 C++26 起)

1) 构造一个 basic_format_string 对象，它存储字符串 s 的视图。如果参数不是编译时常量，或者如果它不能被解析为格式化参数类型 Args 的格式字符串，则构造是非良构的。

此重载仅在 const T& 建模 std::convertible_to<std::basic_string_view<CharT>> 时参与重载解析。

2) 构造一个 basic_format_string 对象，它存储由 std::runtime_format 返回的字符串 s 的视图。它在构造时不会执行格式字符串检查。

参数

s

-

一个表示格式字符串的对象。格式字符串由以下部分组成： 普通字符（除了 { 和 }），它们被不变地复制到输出中， 转义序列 {{ 和 }}，它们在输出中分别被替换为 { 和 }，以及 替换字段。 每个替换字段具有以下格式 { 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 格式规范 和 stacktrace entry 格式规范。 对于 std::basic_stacktrace，不允许使用格式说明符。 (自 C++23 起) 对于 std::filesystem::path，请参阅 路径格式规范。 (自 C++26 起) 对于其他可格式化类型，格式规范由用户定义的 formatter 特化确定。

std::basic_format_string::get

constexpr std::basic_string_view<CharT> get() const noexcept;

返回存储的字符串视图。

注解

别名模板 format_string 和 wformat_string 使用 std::type_identity_t 来抑制模板参数推导。通常，当它们作为函数参数出现时，它们的模板参数是从其他函数参数推导出来的。

template<class... Args>
std::string format(std::format_string<Args...> fmt, Args&&... args);
 
auto s = format("{} {}", 1.0, 2);
// Calls format<double, int>. Args are deduced from 1.0, 2
// Due to the use of type_identity_t in format_string, template argument deduction
// does not consider the type of the format string.

缺陷报告

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

DR	应用于	已发布行为	正确行为
P2508R1	C++20	此功能没有用户可见的名称	名称 basic_format_string 被公开