std::format_to

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

工具库

语言支持 类型支持（基本类型、 RTTI 、类型特征）     库功能特性测试宏 (C++20) 动态内存管理 程序工具 错误处理 协程支持 (C++20) 变参数函数 launder (C++17) initializer_list (C++11) source_location (C++20) 三路比较 (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20) is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

通用工具 日期和时间 函数对象 bitset 格式化库 (C++20) hash (C++11) integer_sequence (C++14) 关系运算符 (C++20 中弃用) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= 整数比较函数 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20) cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) swap 与类型运算 swap ranges::swap (C++20) exchange (C++14) declval (C++11) forward (C++11) move (C++11) move_if_noexcept (C++11) as_const (C++17) to_underlying (C++23) 常用词汇类型 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) 栈踪 stacktrace_entry (C++23) basic_stacktrace (C++23)

 

格式化库

格式化函数

format (C++20)

format_to (C++20)

format_to_n (C++20)

formatted_size (C++20)

vformat (C++20)

vformat_to (C++20)

格式化器

formatter (C++20)

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)

格式化参数

basic_format_arg (C++20)

basic_format_argsformat_argswformat_args (C++20)(C++20)(C++20)

visit_format_arg (C++20)

make_format_argsmake_wformat_args (C++20)(C++20)

格式错误

format_error (C++20)

 

定义于头文件 <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,                     /*format_string<Args...>*/ fmt, const Args&... args );	(3)	(C++20 起)
template< class OutputIt, class... Args > OutputIt format_to( OutputIt out, const std::locale& loc,                     /*wformat_string<Args...>*/ fmt, const Args&... args );	(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	-	未指定类型的形参，其初始化仅若实参可转换成 std::string_view （对于 (1,3) ）或 std::wstring_view （对于 (2,4) ），而转换结果是常量表达式和 Args 的合法格式字符串才合法。格式字符串由以下内容组成： 通常字符（除了 { 与 } ），它们被不加修改地复制到输出， 转义序列 {{ 与 }} ，它们在输出中被分别替换成 { 与 } ，以及 替换域。 每个替换域拥有下列格式： 引入的 { 字符； (可选) arg-id ，一个非负数； (可选) 冒号（ : ）后随格式说明； 终止的 } 字符。 arg-id 指定用于格式化其值的 args 中的参数的下标；若省略 arg-id ，则按顺序使用参数。格式字符串中的 arg-id 必须全部存在或全部被省略。混合手动和自动指定下标是错误。 格式说明由对应参数特化的 std::formatter 定义。 对于基本类型和标准字符串类型，格式说明为标准格式说明； 对于标准日期和时间类型，格式说明为 chrono 格式说明； 对于用户定义类型，格式说明由用户定义的 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	非法格式字符串导致编译时错误

参阅

format (C++20)	在新 string 中存储参数的格式化表示 (函数模板)
format_to_n (C++20)	通过输出迭代器写其参数的格式化表示，不超出指定的大小 (函数模板)