std::formatter<pair-or-tuple>

 

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, std::formattable<CharT>... Ts > struct formatter</*pair-or-tuple*/<Ts...>, CharT>;		(自 C++23 起)

用于 std::formatter 的模板特化，针对 std::pair 和 std::tuple，允许用户使用 格式化函数 将 pair 或 tuple 转换为其文本表示形式，作为元素的集合。

仅供演示用的名称 /*pair-or-tuple*/ 表示类模板 std::pair 或 std::tuple。

如果 (std::formattable<const Ts, CharT> && ...) 为 true，则此特化满足 Formatter 的要求。它始终满足 BasicFormatter 的要求。

格式规范

tuple-format-spec 的语法是

tuple-fill-and-align (可选) width (可选) tuple-type (可选)

tuple-fill-and-align 的解释方式与 fill-and-align 相同，除了 tuple-fill-and-align 中的 fill 是除 {、} 或 : 之外的任何字符。

width 在 标准格式宽度规范 中描述。

tuple-type 更改了 tuple 的格式化方式，某些选项仅对某些参数类型有效。

可用的 tuple 表示类型有

• m：表示开始和结束括号都应为 ""，而分隔符应为 ": "。

• 如果选择 m 作为 tuple-type，则除非 sizeof...(Ts) == 2 为 true，否则程序是非良构的。

• n：表示分隔符、开始和结束括号都应为 ""。

成员对象

成员名称	定义
underlying_ (私有)	类型为 std::tuple<std::formatter<std::remove_cvref_t<Ts>, CharT>...> 的底层格式化器的 tuple (仅供演示的成员对象*)
separator_ (私有)	表示 tuple 格式化结果分隔符的字符串 (默认为 ", ") (仅供演示的成员对象*)
opening-bracket_ (私有)	表示 tuple 格式化结果开始括号的字符串 (默认为 "(") (仅供演示的成员对象*)
closing-bracket_ (私有)	表示 tuple 格式化结果结束括号的字符串 (默认为 ")") (仅供演示的成员对象*)

成员函数

set_separator	为 tuple 格式化结果设置指定的分隔符 (公共成员函数)
set_brackets	为 tuple 格式化结果设置指定的开始和结束括号 (公共成员函数)
parse	解析 tuple-format-spec 指定的格式说明符 (公共成员函数)
format	写入 tuple-format-spec 指定的 tuple 格式化输出 (公共成员函数)

std::formatter<pair-or-tuple>::set_separator

constexpr void set_separator( std::basic_string_view<CharT> sep ) noexcept;

将 sep 赋值给 separator_。

std::formatter<pair-or-tuple>::set_brackets

constexpr void set_brackets( std::basic_string_view<CharT> opening,                              std::basic_string_view<CharT> closing ) noexcept;

分别将 opening 和 closing 赋值给 opening-bracket_ 和 closing-bracket_。

std::formatter<pair-or-tuple>::parse

template< class ParseContext > constexpr auto parse( ParseContext& ctx ) -> ParseContext::iterator;

将格式说明符解析为 tuple-format-spec，并将解析后的说明符存储在当前对象中。

如果存在 tuple-type 或 n 选项，则根据需要修改 opening-bracket、closing-bracket 和 separator 的值。

对于 underlying_ 中的每个元素 e，调用 e.parse(ctx) 来解析一个空的 format-spec，并且，如果 e.set_debug_format() 是有效表达式，则调用 e.set_debug_format()。

返回一个迭代器，该迭代器超过 tuple-format-spec 的末尾。

std::formatter<pair-or-tuple>::format

template< class FormatContext > FormatContext::iterator format( /*maybe-const-pair-or-tuple*/<Ts...>& elems, FormatContext& ctx ) const;

/*maybe-const-pair-or-tuple*/ 表示

• 如果 (std::formattable<const Ts, CharT> && ...) 为 true，则为 const /*pair-or-tuple*/，
• 否则为 /*pair-or-tuple*/。

按照 tuple-format-spec 的指定，按顺序将以下内容写入 ctx.out() 中

• opening-bracket_,
• 对于 [​0​, sizeof...(Ts)) 中的每个索引 I

• 如果 I != 0，则为 separator_，
• 通过 std::get<I>(underlying_) 写入 std::get<I>(elems) 的结果，以及

• closing-bracket_.

返回一个迭代器，该迭代器超过输出范围的末尾。

缺陷报告

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

DR	应用于	已发布行为	正确行为
LWG 3892	C++23	嵌套 tuple 的格式化不正确	已更正

参见

formatter (C++20)

为给定类型定义格式化规则 (类模板)