std::format_to_n, std::format_to_n_result

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名要求

功能测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持 (基本类型，RTTI) 库功能测试宏 (C++20) 动态内存管理 程序工具 协程支持 (C++20) 可变参数函数 is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) 调试支持 is_debugger_present (C++26) breakpoint_if_debugging (C++26) breakpoint (C++26) 三方比较 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_ltis_lteq (C++20)(C++20)(C++20) is_neqis_gtis_gteq (C++20)(C++20)(C++20)

通用工具 日期和时间 函数对象 格式库 (C++20) bitset hash (C++11) 关系运算符 (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 ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) 通用词汇类型 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) expected (C++23) 基本字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

格式库

标准格式规范

格式化函数

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)

 

在头文件 <format> 中定义
template< class OutputIt, class... Args > std::format_to_n_result<OutputIt>     format_to_n( OutputIt out, std::iter_difference_t<OutputIt> n,                  std::format_string<Args...> fmt, 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,                  std::wformat_string<Args...> fmt, 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,                  std::format_string<Args...> fmt, 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,                  std::wformat_string<Args...> fmt, 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，重载 (2,4) 的 wchar_t。

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

如果 OutputIt 不建模（不满足 std::output_iterator<const CharT&> 的语义要求），或者如果 std::formatter<std::remove_cvref_t<Ti>, CharT> 对于 Args 中的任何 Ti 不满足 BasicFormatter 要求，则行为未定义。

5) std::format_to_n_result 没有基类，也没有除 out、size 和隐式声明的特殊成员函数之外的成员。

参数

out	-	指向输出缓冲区的迭代器
n	-	要写入缓冲区的最大字符数
fmt	-	一个表示格式字符串的对象。格式字符串由以下组成： 普通字符（除了 { 和 }），它们会被原样复制到输出中； 转义序列 {{ 和 }}，它们分别替换为输出中的 { 和 }；以及 替换字段。 每个替换字段都具有以下格式： { arg-id (可选) } (1) { arg-id (可选) : format-spec } (2) 1) 没有格式规范的替换字段 2) 有格式规范的替换字段 arg-id - 指定 args 中要用于格式化的参数的索引；如果省略，则按顺序使用参数。 格式字符串中的 arg-id s 必须全部存在或全部省略。混合手动和自动索引是错误的。 format-spec - 由对应参数的 std::formatter 特化定义的格式规范。不能以 } 开头。 对于基本类型和标准字符串类型，格式规范被解释为 标准格式规范。 对于 chrono 类型，格式规范被解释为 chrono 格式规范。 对于范围类型，格式规范被解释为 范围格式规范。 对于 std::pair 和 std::tuple，格式规范被解释为 元组格式规范。 对于 std::thread::id 和 std::stacktrace_entry，请参见 线程 ID 格式规范 和 堆栈跟踪条目格式规范。 对于 std::basic_stacktrace，不允许使用任何格式说明符。 (自 C++23 起) 对于 std::filesystem::path，请参见 路径格式规范。 (自 C++26 起) 对于其他可格式化的类型，格式规范由用户定义的 formatter 特化确定。
args...	-	要格式化的参数
loc	-	std::locale 用于特定于区域设置的格式化

返回值

一个 format_to_n_result，其 out 成员是输出范围的末尾迭代器，size 成员是总（未截断）输出大小。

异常

传播格式化程序或迭代器操作引发的任何异常。

注释

在 GCC-13.3 之前，libstdc++ 实现存在 错误，无法报告正确的 format_to_n_result::out 值。

示例

在 Godbolt 的编译器资源管理器中：clang（主干）+ libc++，GCC（主干）+ libstdc++。

运行此代码

#include <format>
#include <initializer_list>
#include <iomanip>
#include <iostream>
#include <string_view>
 
int main()
{
    char buffer[64];
 
    for (std::size_t max_chars_to_write : {std::size(buffer) - 1, 23uz, 21uz})
    {
        const std::format_to_n_result result =
            std::format_to_n(
                buffer, max_chars_to_write,
                "Hubble's H{2} {3} {0}{4}{1} km/sec/Mpc.", // 24 bytes w/o formatters
                71,       // {0}, occupies 2 bytes
                8,        // {1}, occupies 1 byte
                "\u2080", // {2}, occupies 3 bytes, '₀' (SUBSCRIPT ZERO)
                "\u2245", // {3}, occupies 3 bytes, '≅' (APPROXIMATELY EQUAL TO)
                "\u00B1"  // {4}, occupies 2 bytes, '±' (PLUS-MINUS SIGN)
                ); // 24 + 2 + 1 + 3 + 3 + 2 == 35, no trailing '\0'
 
        *result.out = '\0'; // adds terminator to buffer
 
        const std::string_view str(buffer, result.out);
 
        std::cout << "Buffer until '\\0': " << std::quoted(str) << '\n'
                  << "Max chars to write: " << max_chars_to_write << '\n'
                  << "result.out offset: " << result.out - buffer << '\n'
                  << "Untruncated output size: " << result.size << "\n\n";
    }
}

输出

Buffer until '\0': "Hubble's H₀ ≅ 71±8 km/sec/Mpc."
Max chars to write: 63
result.out offset: 35
Untruncated output size: 35
 
Buffer until '\0': "Hubble's H₀ ≅ 71±8"
Max chars to write: 23
result.out offset: 23
Untruncated output size: 35
 
Buffer until '\0': "Hubble's H₀ ≅ 71�"
Max chars to write: 21
result.out offset: 21
Untruncated output size: 35

缺陷报告

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

DR	应用于	已发布的行为	正确行为
P2216R3	C++20	对于无效的格式字符串，会抛出 std::format_error	无效的格式字符串会导致编译时错误
P2418R2	C++20	既不可用作常量也不可复制的对象 (例如生成器类对象) 不可格式化	允许格式化这些对象
P2508R1	C++20	此功能没有用户可见的名称	暴露了 basic_format_string 名称

另请参阅

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