std::format_to_n

来自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++23)
初等字符串转换
(C++17)
(C++17)
 
格式化库
格式化函数
(C++20)
(C++20)
format_to_n
(C++20)
(C++20)
(C++20)
格式化概念
格式化器
(C++20)
格式化参数
(C++20) (C++26 中弃用)
格式错误
 
在标头 <format> 定义
template< class OutputIt, class... Args >

std::format_to_n_result<OutputIt>
    format_to_n( OutputIt out, std::iter_difference_t<OutputIt> n,

                 /*format_string<Args...>*/ fmt, const Args&... args );
(1) (C++20 起)
template< class OutputIt, class... Args >

std::format_to_n_result<OutputIt>
    format_to_n( OutputIt out, std::iter_difference_t<OutputIt> n,

                 /*wformat_string<Args...>*/ fmt, const Args&... args );
(2) (C++20 起)
template< class OutputIt, class... Args >

std::format_to_n_result<OutputIt>
    format_to_n( OutputIt out, std::iter_difference_t<OutputIt> n,

                 const std::locale& loc, /*format_string<Args...>*/ fmt, const Args&... args );
(3) (C++20 起)
template< class OutputIt, class... Args >

std::format_to_n_result<OutputIt>
    format_to_n( OutputIt out, std::iter_difference_t<OutputIt> n,

                 const std::locale& loc, /*wformat_string<Args...>*/ fmt, const Args&... args );
(4) (C++20 起)
template< class OutputIt >

struct format_to_n_result {
    OutputIt out;
    std::iter_difference_t<OutputIt> size;

};
(5) (C++20 起)

按照格式字符串 fmt 格式化 args ,并写结果到输出迭代器 out 。至多写 n 个字符。 loc 若存在则用于本地环境特定的格式化。

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) 要求则行为未定义。

5) std::format_to_n_result 无基类或 outsize 及隐式声明的特殊成员函数以外的成员。

参数

out - 指向输出缓冲区的迭代器
n - 写入输出缓冲区的最大字符数
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

返回值

format_to_n_result ,其 out 成员为指向输出范围末尾后一位置的迭代器,而 size 成员为总(不截断)的输出大小。

异常

传播格式化器或迭代器操作所抛的任何异常。

示例

#include <format>
#include <string_view>
#include <iostream>
 
int main()
{
    char buffer[64];
 
    const auto result =
        std::format_to_n(buffer, std::size(buffer), 
                         "Hubble's H{0} {1} {2} miles/sec/mpc.",
                         "\u2080", "\u2245", 42);
 
    std::cout << "Buffer: \"" << std::string_view{buffer, result.size} << "\"\n"
              << "Buffer size = " << std::size(buffer) << '\n'
              << "Untruncated output size = " << result.size << '\n';
}

输出:

Buffer: "Hubble's H₀ ≅ 42 miles/sec/mpc."
Buffer size = 64
Untruncated output size = 35

缺陷报告

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

缺陷报告 应用于 出版时的行为 正确行为
P2216R3 C++20 对非法格式字符串抛出 std::format_error 非法格式字符串导致编译时错误

参阅

(C++20)
在新 string 中存储参数的格式化表示
(函数模板)
(C++20)
通过输出迭代器写其参数的格式化表示
(函数模板)
确定存储其参数的格式化表示所需的字符数
(函数模板)