std::format_to

来自cppreference.com
< cpp‎ | utility‎ | format
 
 
工具库
通用工具
格式化库 (C++20)
(C++11)
关系运算符 (C++20 中弃用)
整数比较函数
(C++20)(C++20)(C++20)
(C++20)
swap 与类型运算
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
常用词汇类型
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)

初等字符串转换
(C++17)
(C++17)
栈踪
 
格式化库
格式化函数
(C++20)
format_to
(C++20)
(C++20)
(C++20)
格式化器
(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 ,并写结果到输出迭代器 outloc 若存在则用于本地环境特定的格式化。

CharT 对重载 (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 - 未指定类型的形参,其初始化仅若实参可转换成 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 非法格式字符串导致编译时错误

参阅

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