std::format_to
来自cppreference.com
定义于头文件 <format>
|
||
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, /*format_string<Args...>*/ fmt, const Args&... args ); |
(1) | (C++20 起) |
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, /*wformat_string<Args...>*/ fmt, const Args&... args ); |
(2) | (C++20 起) |
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, const std::locale& loc, |
(3) | (C++20 起) |
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, const std::locale& loc, |
(4) | (C++20 起) |
按照格式字符串 fmt
格式化 args
,并写结果到输出迭代器 out
。 loc
若存在则用于本地环境特定的格式化。
令 CharT
对重载 (1,3) 为 char ,对重载 wchar_t 为 (2,4) 。
这些重载仅若 OutputIt
满足概念 std::output_iterator<const CharT&> 才参与重载决议。
若 OutputIt
不实现(满足其语义要求)概念 std::output_iterator<const CharT&> ,或若对 Args
中任何 Ti
, std::formatter<Ti, CharT> 不满足格式化器 (Formatter) 要求则行为未定义。
参数
out | - | 指向输出缓冲区的迭代器 |
fmt | - | Args 的合法格式字符串才合法。格式字符串由以下内容组成:
每个替换域拥有下列格式:
arg-id 指定用于格式化其值的 格式说明由对应参数特化的 std::formatter 定义。
|
args... | - | 要格式化的参数 |
loc | - | 用于本地环境特定的格式化的 std::locale |
返回值
输出范围末尾后一位置的迭代器。
异常
传播格式化器或迭代器操作所抛的任何异常。
注解
自 P2216R3 起,格式字符串不是常量表达式是错误。此情况下可使用 std::vformat_to 。
示例
运行此代码
#include <format> #include <iostream> #include <iterator> #include <string> auto main() -> int { std::string buffer; std::format_to( std::back_inserter(buffer), //< OutputIt "Hello, C++{}!\n", //< fmt "20"); //< arg std::cout << buffer; buffer.clear(); std::format_to( std::back_inserter(buffer), //< OutputIt "Hello, {0}::{1}!{2}", //< fmt "std", //< arg {0} "format_to()", //< arg {1} "\n", //< arg {2} "extra param(s)..."); //< 不使用 std::cout << buffer; std::wstring wbuffer; std::format_to( std::back_inserter(wbuffer),//< OutputIt L"Hello, {2}::{1}!{0}", //< fmt L"\n", //< arg {0} L"format_to()", //< arg {1} L"std", //< arg {2} L"...is not..." //< 不使用 L"...an error!"); //< 不使用 std::wcout << wbuffer; }
输出:
Hello, C++20! Hello, std::format_to()! Hello, std::format_to()!
缺陷报告
下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。
DR | 应用于 | 出版时的行为 | 正确行为 |
---|---|---|---|
P2216R3 | C++20 | 对非法格式字符串抛出 std::format_error | 非法格式字符串导致编译时错误 |
参阅
(C++20) |
在新 string 中存储参数的格式化表示 (函数模板) |
(C++20) |
通过输出迭代器写其参数的格式化表示,不超出指定的大小 (函数模板) |