std::formatter<pair-or-tuple>

 

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 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 的格式化方式，某些选项仅对某些参数类型有效。

可用的元组表示类型为

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

• 如果选择 m 作为 tuple-type，则除非 sizeof...(Ts) == 2 为 true，否则程序格式错误。

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

成员对象

成员名称	定义
underlying_ (私有)	类型为 std::tuple<std::formatter<std::remove_cvref_t<Ts>, CharT>...> 的基础格式化程序元组 (仅用于说明的成员对象*)
separator_ (私有)	表示元组格式化结果分隔符的字符串（默认为 ", "） (仅用于说明的成员对象*)
opening-bracket_ (私有)	表示元组格式化结果起始括号的字符串（默认为 "("） (仅用于说明的成员对象*)
closing-bracket_ (私有)	表示元组格式化结果结束括号的字符串（默认为 ")"） (仅用于说明的成员对象*)

成员函数

set_separator	为元组格式化结果设置指定的分隔符 (公有成员函数)
set_brackets	为元组格式化的结果设置指定的开闭括号。 (公有成员函数)
解析	解析由 tuple-format-spec 指定的格式说明符。 (公有成员函数)
format	根据 tuple-format-spec 指定的格式写入元组格式化的输出。 (公有成员函数)

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*/ 表示

• const /*pair-or-tuple*/，如果 (std::formattable<const Ts, CharT> && ...) 为 true，
• /*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	嵌套元组的格式化不正确	已更正

另请参阅

formatter (C++20)

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