std::format_to

定义于头文件 `<format>`
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, std::format_string<Args...> fmt, Args&&... args );	(1)	(自 C++20 起)
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, std::wformat_string<Args...> fmt, Args&&... args );	(2)	(自 C++20 起)
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, const std::locale& loc, std::format_string<Args...> fmt, Args&&... args );	(3)	(自 C++20 起)
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, const std::locale& loc, std::wformat_string<Args...> fmt, Args&&... args );	(4)	(自 C++20 起)

根据格式字符串 fmt 格式化 args，并将结果写入输出迭代器 out。如果存在，则 loc 用于特定于区域设置的格式化。

等价于

1) return std::vformat_to(std::move(out), fmt.str, std::make_format_args(args...));

2) return std::vformat_to(std::move(out), fmt.str, std::make_wformat_args(args...));

3) return std::vformat_to(std::move(out), loc, fmt.str, std::make_format_args(args...));

4) return std::vformat_to(std::move(out), loc, fmt.str, std::make_wformat_args(args...));.

设 CharT 为重载 (1,3) 的 char，重载 (2,4) 的 wchar_t。

仅当 OutputIt 满足概念 std::output_iterator<const CharT&> 时，这些重载才参与重载解析。

如果满足以下任何条件，则行为未定义

OutputIt 不符合 std::output_iterator<const CharT&> 模型。
std::formatter<Ti, CharT> 不满足 BasicFormatter 要求（如 std::make_format_args 和 std::make_wformat_args 所要求的那样）对于 Args 中的某些 Ti。

[编辑] 参数

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，格式规范被解释为 tuple 格式规范。
对于 std::thread::id 和 std::stacktrace_entry，请参阅线程 id 格式规范和 stacktrace entry 格式规范。
对于 std::basic_stacktrace，不允许使用格式说明符。

(自 C++23 起)

对于 std::filesystem::path，请参阅路径格式规范。

(自 C++26 起)

对于其他可格式化类型，格式规范由用户定义的 formatter 特化确定。

args... - 要格式化的参数

loc - std::locale 用于特定于区域设置的格式化

[编辑] 返回值

超出输出范围末端的迭代器。

[编辑] 异常

传播由 formatter 或迭代器操作抛出的任何异常。

[编辑] 注解

截至 P2216R3，如果格式字符串不是常量表达式，则会出错。std::vformat_to 或 std::runtime_format(自 C++26 起) 可以在这种情况下使用。

[编辑] 示例

运行此代码

#include <format>
#include <iostream>
#include <iterator>
#include <string>
 
int main()
{
    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)..."         // < unused
    );
    std::cout << buffer << std::flush;
 
    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..."             // < unused
        L"...an error!"             // < unused
    );
    std::wcout << wbuffer;
}

输出

Hello, C++20!
Hello, std::format_to()!
Hello, std::format_to()!

[编辑] 缺陷报告

以下行为变更缺陷报告被追溯应用于先前发布的 C++ 标准。

DR	应用于	已发布行为	正确行为
LWG 3539	C++20	out 不能是仅移动迭代器	它可以是
P2216R3	C++20	为无效的格式字符串抛出 std::format_error	导致编译时错误代替
P2418R2	C++20	既不是 const 可用也不是可复制的对象（例如类似生成器的对象）不可格式化	允许格式化这些对象
P2508R1	C++20	此工具没有用户可见的名称	名称 `basic_format_string` 被公开

[编辑] 参见

format (C++20)	将参数的格式化表示形式存储在新字符串中 (函数模板) [编辑]
format_to_n (C++20)	通过输出迭代器写出其参数的格式化表示形式，不超过指定大小 (函数模板) [编辑]

编译器支持
独立和宿主式
语言
标准库
标准库头文件
具名要求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
诊断库
内存管理库
元编程库 (C++11)
通用工具库
容器库
迭代器库
范围库 (C++20)
算法库
字符串库
文本处理库
数值库
日期和时间库
输入/输出库
文件系统库 (C++17)
并发支持库 (C++11)
执行控制库 (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)

cppreference.cn

命名空间

变体

视图

操作