std::range_formatter

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (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 >     requires std::same_as<std::remove_cvref_t<T>, T> && std::formattable<T, CharT> class range_formatter;		(C++23 起)

std::range_formatter 是一个帮助类模板，用于实现范围 std::formatter 特化。

范围格式规范

range-format-spec 的语法是

range-fill-and-align (可选) width (可选) n(可选) range-type (可选) range-underlying-spec (可选)

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

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

n 选项导致范围在没有开括号和闭括号的情况下进行格式化。

assert(std::format("{}", views::iota(1, 5)) == "[1, 2, 3, 4]");
assert(std::format("{:n}", views::iota(1, 5)) == "1, 2, 3, 4");

如果存在 range-underlying-spec 中的 format-spec（其语法等价于 : format-spec），则由范围元素格式化器 std::formatter<T, CharT> 解释。

std::array ints{12, 10, 15, 14};
 
assert(std::format("{}", ints) == "[12, 10, 15, 14]");
assert(std::format("{::X}", ints) == "[C, A, F, E]");
assert(std::format("{:n:_^4}", ints) == "_12_, _10_, _15_, _14_");

range-type 改变范围的格式化方式，某些选项仅对某些参数类型有效。

可用的范围表示类型为

• m: 表示开括号应为 "{"，闭括号应为 "}"，分隔符应为 ", "，并且每个范围元素应格式化，如同为其 tuple-type（在 tuple-format-spec 中）指定了 m。

• 如果选择 m 作为 range-type，则除非 T 是以下特化之一，否则程序是非良构的：

• std::pair，或
• std::tuple，使得 std::tuple_size_v<T> == 2 为 true。

std::array char_pairs
{
    std::pair{'A', 5}, std::pair{'B', 10}, std::pair{'C', 12}
};
 
assert(std::format("{}", char_pairs) == "[('A', 5), ('B', 10), ('C', 12)]");
assert(std::format("{:m}", char_pairs) == "{'A': 5, 'B': 10, 'C': 12}");

• s: 表示范围应格式化为字符串。
• ?s: 表示范围应格式化为转义字符串。

• 如果选择 s 或 ?s 作为 range-type，则格式说明符中不应包含 n 选项和 range-underlying-spec，并且
• 除非 T 是 CharT，否则程序是非良构的。

std::array star{'S', 'T', 'A', 'R'};
 
assert(std::format("{}", star) == "['S', 'T', 'A', 'R']");
assert(std::format("{:s}", star) == "STAR");
assert(std::format("{:?s}", star) == "\"STAR\"");

数据成员

成员名称 (Member name)	定义
std::formatter<T, CharT> underlying_ (私有)	元素的底层格式化器 (仅用于阐释的成员对象*)
std::basic_string_view<CharT> separator_ (私有)	表示范围格式化结果分隔符的字符串。默认分隔符为 ", "。 (仅用于阐释的成员对象*)
std::basic_string_view<CharT> opening-bracket_ (私有)	表示范围格式化结果开括号的字符串。默认开括号为 "["。 (仅用于阐释的成员对象*)
std::basic_string_view<CharT> closing-bracket_ (私有)	表示范围格式化结果闭括号的字符串。默认闭括号为 "]"。 (仅用于阐释的成员对象*)

成员函数

set_separator	为范围格式化结果设置指定的分隔符 (公开成员函数)
set_brackets	为范围格式化结果设置指定的开括号和闭括号 (公开成员函数)
underlying	返回底层格式化器 (公开成员函数)
parse	按 range-format-spec 指定解析格式说明符 (公开成员函数)
format	按 range-format-spec 指定写入范围格式化输出 (公开成员函数)

std::range_formatter::set_separator

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

将 sep 赋值给 separator_。

std::range_formatter::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::range_formatter::underlying

constexpr std::formatter<T, CharT>& underlying();	(1)
constexpr const std::formatter<T, CharT>& underlying() const;	(2)

返回 underlying_（底层格式化器）。

std::range_formatter::parse

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

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

调用 underlying_.parse(ctx) 以解析 range-format-spec 中的 format-spec，如果后者不存在，则解析空的 format-spec。

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

如果满足以下条件，它将调用 underlying_.set_debug_format()：

• range-type 既不是 s 也不是 ?s，
• underlying_.set_debug_format() 是一个有效的表达式，并且
• 没有 range-underlying-spec。

返回 range-format-spec 结束后的迭代器。

std::range_formatter::format

template< ranges::input_range R, class FormatContext >   requires std::formattable<ranges::range_reference_t<R>, CharT> &&            std::same_as<std::remove_cvref_t<ranges::range_reference_t<R>>, T> auto format( R&& r, FormatContext& ctx ) const -> FormatContext::iterator;

如果 range-type 是 s 或 ?s，它分别将格式化的 std::basic_string<CharT>(std::from_range, r) 作为字符串或转义字符串写入 ctx.out()。

否则，它将按照 range-format-spec 指定的顺序将以下内容写入 ctx.out()：

• opening-bracket_,
• 对于范围 r 的每个可格式化元素 e

• 通过 underlying_ 写入 e 的结果，以及
• separator_，除非 e 是 r 的最后一个元素，以及

• closing-bracket_.

返回一个迭代器，指向输出范围的末尾之后。

缺陷报告

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

缺陷报告	应用于	发布时的行为	正确的行为
LWG 3892	C++23	嵌套范围的格式化不正确	已更正

另请参阅

formatter (C++20)

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