std::formatter

 

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 T, class CharT = char > struct formatter;		(自 C++20 起)

std::formatter 的已启用特化为给定类型定义了格式化规则。已启用特化满足 BasicFormatter 要求，并且，除非另有说明，否则也满足 Formatter 要求。

对于所有类型 T 和 CharT，如果未启用特化 std::formatter<T, CharT>，则该特化是完整类型并且被禁用。

禁用的特化不满足 Formatter 要求，并且以下所有项均为 false

• std::is_default_constructible_v
• std::is_copy_constructible_v
• std::is_move_constructible_v
• std::is_copy_assignable_v
• std::is_move_assignable_v.

基本标准特化

在以下列表中，CharT 是 char 或 wchar_t，ArithmeticT 是任何 cv-非限定算术类型，但 char、wchar_t、char8_t、char16_t 或 char32_t 除外

字符格式化器
template<> struct formatter<char, char>;	(1)
template<> struct formatter<char, wchar_t>;	(2)
template<> struct formatter<wchar_t, wchar_t>;	(3)
字符串格式化器
template<> struct formatter<CharT*, CharT>;	(4)
template<> struct formatter<const CharT*, CharT>;	(5)
template< std::size_t N > struct formatter<CharT[N], CharT>;	(6)
template< class Traits, class Alloc > struct formatter<std::basic_string<CharT, Traits, Alloc>, CharT>;	(7)
template< class Traits > struct formatter<std::basic_string_view<CharT, Traits>, CharT>;	(8)
算术格式化器
template<> struct formatter<ArithmeticT, CharT>;	(9)
指针格式化器
template<> struct formatter<std::nullptr_t, CharT>;	(10)
template<> struct formatter<void*, CharT>;	(11)
template<> struct formatter<const void*, CharT>;	(12)

其他指针和成员指针的格式化器被禁用。

诸如 std::formatter<wchar_t, char> 和 std::formatter<const char*, wchar_t> 这样需要编码转换的特化被禁用。

以下特化在 C++23 中仍然被禁用，以避免将某些 char 序列格式化为 wchar_t 的范围 wchar_t 的禁用格式化器 template<> struct formatter<char*, wchar_t>; (1) template<> struct formatter<const char*, wchar_t>; (2) template< std::size_t N > struct formatter<char[N], wchar_t>; (3) template< class Traits, class Allocator > struct formatter<std::basic_string<char, Traits, Allocator>, wchar_t>; (4) template< class Traits > struct formatter<std::basic_string_view<char, Traits>, wchar_t>; (5) 启用调试的格式化器特化还提供了一个公共非静态成员函数 constexpr void set_debug_format();，它修改格式化器对象的状态，使其将值格式化为转义和引用，就像上次调用 parse 解析的格式说明符的 type 是 ? 一样。 字符串或字符类型的每个格式化器特化都是启用调试的。

(自 C++23 起)

库类型的标准特化

std::formatter<std::chrono::duration> (C++20)	duration 的格式化支持 (类模板特化)
std::formatter<std::chrono::sys_time> (C++20)	sys_time 的格式化支持 (类模板特化)
std::formatter<std::chrono::utc_time> (C++20)	utc_time 的格式化支持 (类模板特化)
std::formatter<std::chrono::tai_time> (C++20)	tai_time 的格式化支持 (类模板特化)
std::formatter<std::chrono::gps_time> (C++20)	gps_time 的格式化支持 (类模板特化)
std::formatter<std::chrono::file_time> (C++20)	file_time 的格式化支持 (类模板特化)
std::formatter<std::chrono::local_time> (C++20)	local_time 的格式化支持 (类模板特化)
std::formatter<std::chrono::day> (C++20)	day 的格式化支持 (类模板特化)
std::formatter<std::chrono::month> (C++20)	month 的格式化支持 (类模板特化)
std::formatter<std::chrono::year> (C++20)	year 的格式化支持 (类模板特化)
std::formatter<std::chrono::weekday> (C++20)	weekday 的格式化支持 (类模板特化)
std::formatter<std::chrono::weekday_indexed> (C++20)	weekday_indexed 的格式化支持 (类模板特化)
std::formatter<std::chrono::weekday_last> (C++20)	weekday_last 的格式化支持 (类模板特化)
std::formatter<std::chrono::month_day> (C++20)	month_day 的格式化支持 (类模板特化)
std::formatter<std::chrono::month_day_last> (C++20)	month_day_last 的格式化支持 (类模板特化)
std::formatter<std::chrono::month_weekday> (C++20)	month_weekday 的格式化支持 (类模板特化)
std::formatter<std::chrono::month_weekday_last> (C++20)	month_weekday_last 的格式化支持 (类模板特化)
std::formatter<std::chrono::year_month> (C++20)	year_month 的格式化支持 (类模板特化)
std::formatter<std::chrono::year_month_day> (C++20)	year_month_day 的格式化支持 (类模板特化)
std::formatter<std::chrono::year_month_day_last> (C++20)	year_month_day_last 的格式化支持 (类模板特化)
std::formatter<std::chrono::year_month_weekday> (C++20)	year_month_weekday 的格式化支持 (类模板特化)
std::formatter<std::chrono::year_month_weekday_last> (C++20)	year_month_weekday_last 的格式化支持 (类模板特化)
std::formatter<std::chrono::hh_mm_ss> (C++20)	hh_mm_ss 的格式化支持 (类模板特化)
std::formatter<std::chrono::sys_info> (C++20)	sys_info 的格式化支持 (类模板特化)
std::formatter<std::chrono::local_info> (C++20)	local_info 的格式化支持 (类模板特化)
std::formatter<std::chrono::zoned_time> (C++20)	zoned_time 的格式化支持 (类模板特化)
std::formatter<std::basic_stacktrace> (C++23)	basic_stacktrace 的格式化支持 (类模板特化)
std::formatter<std::stacktrace_entry> (C++23)	stacktrace_entry 的格式化支持 (类模板特化)
std::formatter<std::thread::id> (C++23)	thread::id 的格式化支持 (类模板特化)
std::formatter<std::vector<bool>::reference> (C++23)	vector<bool>::reference 的格式化支持 (类模板特化)
std::formatter<pair-or-tuple> (C++23)	pair 和 tuple 的格式化支持 (类模板特化)
std::formatter<range> (C++23)	ranges 的格式化支持 (类模板特化)
std::formatter<std::stack> (C++23)	std::stack 的格式化支持 (类模板特化)
std::formatter<std::queue> (C++23)	std::queue 的格式化支持 (类模板特化)
std::formatter<std::priority_queue> (C++23)	std::priority_queue 的格式化支持 (类模板特化)
std::formatter<std::filesystem::path> (C++26)	filesystem::path 的格式化支持 (类模板特化)

示例

运行此代码

#include <algorithm>
#include <format>
#include <iomanip>
#include <iostream>
#include <sstream>
#include <string_view>
 
struct QuotableString : std::string_view
{};
 
template<>
struct std::formatter<QuotableString, char>
{
    bool quoted = false;
 
    template<class ParseContext>
    constexpr ParseContext::iterator parse(ParseContext& ctx)
    {
        auto it = ctx.begin();
        if (it == ctx.end())
            return it;
 
        if (*it == '#')
        {
            quoted = true;
            ++it;
        }
        if (it != ctx.end() && *it != '}')
            throw std::format_error("Invalid format args for QuotableString.");
 
        return it;
    }
 
    template<class FmtContext>
    FmtContext::iterator format(QuotableString s, FmtContext& ctx) const
    {
        std::ostringstream out;
        if (quoted)
            out << std::quoted(s);
        else
            out << s;
 
        return std::ranges::copy(std::move(out).str(), ctx.out()).out;
    }
};
 
int main()
{
    QuotableString a("be"), a2(R"( " be " )");
    QuotableString b("a question");
    std::cout << std::format("To {0} or not to {0}, that is {1}.\n", a, b);
    std::cout << std::format("To {0:} or not to {0:}, that is {1:}.\n", a, b);
    std::cout << std::format("To {0:#} or not to {0:#}, that is {1:#}.\n", a2, b);
}

输出

To be or not to be, that is a question.
To be or not to be, that is a question.
To " \" be \" " or not to " \" be \" ", that is "a question".

缺陷报告

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

DR	应用于	已发布行为	正确行为
LWG 3944	C++23	一些 char 序列可格式化为 wchar_t 的范围	禁用添加的特化

参见

basic_format_contextformat_contextwformat_context (C++20)(C++20)(C++20)	格式化状态，包括所有格式化参数和输出迭代器 (类模板)
formattable (C++23)	指定类型是可格式化的，即，它特化 std::formatter 并提供成员函数 parse 和 format (概念)
range_formatter (C++23)	帮助为范围类型实现 std::formatter 特化的类模板 (类模板)