std::vformat_to

来自cppreference.com
< cpp‎ | utility‎ | format
 
 
工具库
语言支持
类型支持(基本类型、RTTI)
库功能特性测试宏 (C++20)
动态内存管理
程序工具
协程支持 (C++20)
变参数函数
调试支持
(C++26)
三路比较
(C++20)
(C++20)(C++20)(C++20)
(C++20)(C++20)(C++20)
通用工具
日期和时间
函数对象
格式化库 (C++20)
(C++11)
关系运算符 (C++20 中弃用)
整数比较函数
(C++20)(C++20)(C++20)   
(C++20)
交换类型运算
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
常用词汇类型
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++23)
初等字符串转换
(C++17)
(C++17)

 
 
在标头 <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 所持有的实参,并写结果到输出迭代器 outloc 若存在,则用于本地环境特定的格式化。

CharTdecltype(fmt)::char_type(对重载 (1,3)char,对重载 wchar_t(2,4))。

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

OutputIt 必须实现(满足其语义要求)概念 std::output_iterator<const CharT&>,且对于 Args 中的任何 Tistd::formatter<Ti, CharT> 都必须满足格式化器 (Formatter) 要求,否则,其行为未定义。

参数

out - 指向输出缓冲区的迭代器
fmt - 用于表示格式字符串的对象。格式字符串由以下组成
  • 通常字符(除了 {}),它们被不加修改地复制到输出,
  • 转义序列 {{}} ,它们在输出中被分别替换成 {} ,以及
  • 替换域。

每个替换域拥有如下格式:

{ 实参索引 (可选) } (1)
{ 实参索引 (可选) : 格式说明 } (2)
1) 没有格式说明的替换域
2) 有格式说明的替换域
实参索引 - 指定用于格式化它的值的 args 中的参数的下标;如果省略实参索引,那么按顺序使用参数。

格式字符串中的实参索引 必须全部存在或全部被省略。混合手动和自动指定下标是错误。

格式说明 - 格式说明由对应参数特化的 std::formatter 定义。不能以 } 开始。

(C++23 起)
(C++26 起)
  • 对于其他可格式化类型,格式说明由用户定义的 std::formatter 特化决定。
args... - 要格式化的实参
loc - 用于本地环境特定的格式化的 std::locale

返回值

输出范围末尾后一位置的迭代器。

异常

fmt 对于提供的参数不是合法的格式字符串则抛出 std::format_error。并且会传播格式化器或迭代器操作所抛的任何异常。

示例

缺陷报告

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

缺陷报告 应用于 出版时的行为 正确行为
P2216R3 C++20 args 的类型在 OutputIt 上参数化 不参数化

参阅