std::formatted_size

���自cppreference.com
 
C++
 
文本处理库
 
格式化库
标准格式说明
格式化函数
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
格式字符串
(C++20)(C++20)(C++20)
(C++26)
格式化概念
(C++23)
格式化器
(C++20)
(C++23)
(C++23)
(C++23)
(C++23)
(C++20)(C++20)(C++20)
(C++20)(C++20)(C++20)
(C++23)
(C++23)
格式化参数
(C++20)
(C++20)
(C++20)(C++20)(C++20)
(C++20) (C++26 弃用)
(C++20)(C++20)
格式错误
(C++20)
 
在标头 <format> 定义 
template< class... Args >
std::size_t formatted_size( std::format_string<Args...> fmt, Args&&... args );
(1) (C++20 起) 
template< class... Args >
std::size_t formatted_size( std::wformat_string<Args...> fmt, Args&&... args );
(2) (C++20 起) 
template< class... Args >
std::size_t formatted_size( const std::locale& loc,
                            std::format_string<Args...> fmt, Args&&... args );
(3) (C++20 起) 
template< class... Args >
std::size_t formatted_size( const std::locale& loc,
                            std::wformat_string<Args...> fmt, Args&&... args );
(4) (C++20 起)

确定按照格式字符串 fmt 格式化 args 得到的有格式字符串的总字符数。loc 若存在则用于本地环境特定的格式化。

若对于 Args 中的任何 Ti，std::formatter<Ti, CharT> 不满足格式化器 (Formatter) 的要求，则其行为未定义。

参数

fmt -
[编辑]
用于表示格式字符串的对象。格式字符串由以下组成
  • 通常字符（除了 { 与 }），它们被不加修改地复制到输出，
  • 转义序列 {{ 与 }} ，它们在输出中被分别替换成 { 与 } ，以及
  • 替换域。

每个替换域拥有如下格式：

{ 实参索引 (可选) } (1)
{ 实参索引 (可选) : 格式说明 } (2)
1) 没有格式说明的替换域
2) 有格式说明的替换域
实参索引 - 指定用于格式化它的值的 args 中的参数的下标；如果省略实参索引，那么按顺序使用参数。

格式字符串中的实参索引 必须全部存在或全部被省略。混合手动和自动指定下标是错误。

格式说明 - 格式说明由对应参数特化的 std::formatter 定义。不能以 } 开始。

(C++23 起)
(C++26 起)
  • 对于其他可格式化类型，格式说明由用户定义的 std::formatter 特化决定。
args... - 要格式化的实参
loc - 用于本地环境特定的格式化的 std::locale

返回值

有格式字符串中的总字符数。

异常

传播格式化器所抛的任何异常。

示例

运行此代码
#include <format>
#include <iomanip>
#include <iostream>
#include <string_view>
#include <vector>

int main()
{
    using namespace std::literals::string_view_literals;

    constexpr auto fmt_str { "Hubble's H{0} {1} {2:*^4} miles/sec/mpc."sv };
    constexpr auto sub_zero{"\N{SUBSCRIPT ZERO}"sv}; // "₀" 或 {0342, 130, 128}
    constexpr auto aprox_equ{"\N{APPROXIMATELY EQUAL TO}"sv}; // "≅" 或 {0342, 137, 133}
    constexpr int Ho { 42 }; // H₀

    const auto min_buffer_size{std::formatted_size(fmt_str, sub_zero, aprox_equ, Ho)};
    std::cout << "最小缓冲区大小 = " << min_buffer_size << '\n';

    // 以 std::vector 为动态缓冲区。缓冲区不包含尾随 '\0' 。
    std::vector<char> buffer(min_buffer_size); 

    std::format_to_n(buffer.data(), buffer.size(), fmt_str, sub_zero, aprox_equ, Ho);
    std::cout << "缓冲区: "
              << std::quoted(std::string_view{buffer.data(), min_buffer_size})
              << '\n';

    // 添加尾随 '\0' 后直接打印缓冲区。
    buffer.push_back('\0');
    std::cout << "缓冲区: " << std::quoted(buffer.data()) << '\n';
}

输出： 

最小缓冲区大小 = 37
缓冲区: "Hubble's H₀ ≅ *42* miles/sec/mpc."
缓冲区: "Hubble's H₀ ≅ *42* miles/sec/mpc."

缺陷报告

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

缺陷报告 应用于 出版时的行为 正确行为
P2216R3 C++20 对非法格式字符串抛出 std::format_error 非法格式字符串导致编译时错误
P2418R2 C++20 无法格式化既非 const 可用也不可复制的对象（如生成器式对象） 允许格式化这些对象
P2508R1 C++20 这个设施没有用户可见的名字 暴露出 basic_format_string 的名字

参阅

(C++20)
 通过输出迭代器写入其实参的格式化表示
(函数模板) [编辑]
(C++20)
 通过输出迭代器写入其实参的格式化表示，不超出指定的大小
(函数模板) [编辑]