std::vformat_to

 

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 OutputIt > OutputIt vformat_to( OutputIt out, std::string_view fmt, std::format_args args );	(1)	(C++20 起)
template< class OutputIt > OutputIt vformat_to( OutputIt out, std::wstring_view fmt, std::wformat_args args );	(2)	(C++20 起)
template< class OutputIt > OutputIt vformat_to( OutputIt out, const std::locale& loc,                      std::string_view fmt, std::format_args args );	(3)	(C++20 起)
template< class OutputIt > OutputIt vformat_to( OutputIt out, const std::locale& loc,                      std::wstring_view fmt, std::wformat_args args );	(4)	(C++20 起)

根据格式字符串 fmt 格式化 args 中保存的参数，并将结果写入输出迭代器 out。如果存在，loc 用于语言环境特定的格式化。

令 CharT 为 decltype(fmt)::char_type (对于重载 (1,3) 为 char，对于重载 (2,4) 为 wchar_t)。

这些重载只有在 OutputIt 满足概念 std::output_iterator<const CharT&> 时才参与重载决议。

OutputIt 必须建模（满足语义要求）概念 std::output_iterator<const CharT&>，并且 std::formatter<Ti, CharT> 必须满足任何参数类型 Ti 的 Formatter 要求。否则，行为是未定义的。

参数

out	-	指向输出缓冲区的迭代器
fmt	-	表示格式化字符串的对象。格式化字符串由以下部分组成： 普通字符（除了 { 和 }），它们不变地复制到输出中， 转义序列 {{ 和 }}，它们分别在输出中替换为 { 和 }，以及 替换字段。 每个替换字段具有以下格式： { 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，格式规范被解释为元组格式规范。 对于 std::thread::id 和 std::stacktrace_entry，请参见线程 ID 格式规范和栈追踪条目格式规范。 对于 std::basic_stacktrace，不允许使用格式化说明符。 (C++23 起) 对于 std::filesystem::path，请参阅路径格式化规范。 (C++26 起) 对于其他可格式化类型，格式化规范由用户定义的 formatter 特化决定。
args	-	要格式化的参数
loc	-	用于特定于语言环境的格式化的 std::locale

返回值

输出范围末尾的迭代器。

异常

如果 fmt 对于提供的参数不是有效的格式字符串，则抛出 std::format_error。也会传播由格式化器或迭代器操作抛出的任何异常。

缺陷报告

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

缺陷报告	应用于	发布时的行为	正确的行为
P2216R3	C++20	args 的类型根据 OutputIt 进行参数化	不参数化