命名空间
变体
操作

std::formatted_size

来自 cppreference.cn
< cpp‎ | 工具‎ | 格式化
 
 
 
 
定义于头文件 <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 用于特定于区域设置的格式化。

如果 std::formatter<std::remove_cvref_t<Ti>, CharT> 不满足 Args 中任何 TiBasicFormatter 要求,则行为未定义。

目录

[编辑] 参数

fmt - 表示格式化字符串的对象。格式化字符串由以下部分组成:
  • 普通字符(除了 {}),它们被原样复制到输出,
  • 转义序列 {{}},它们分别在输出中替换为 {},以及
  • 替换字段。

每个替换字段具有以下格式:

{ arg-id (可选) } (1)
{ arg-id (可选) : format-spec } (2)
1) 没有格式化规范的替换字段
2) 带有格式化规范的替换字段
arg-id - 指定 args 中用于格式化的参数的索引;如果省略,则按顺序使用参数。

格式化字符串中的 arg-id 必须全部存在或全部省略。混合手动和自动索引是错误的。

format-spec - 由相应参数的 std::formatter 特化定义的格式规范。不能以 } 开头。

(C++23 起)
(C++26 起)
  • 对于其他可格式化类型,格式化规范由用户定义的 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}; // "₀" or {0342, 130, 128}
    constexpr auto aprox_equ{"\N{APPROXIMATELY EQUAL TO}"sv}; // "≅" or {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 = " << min_buffer_size << '\n';
 
    // Use std::vector as dynamic buffer. The buffer does not include the trailing '\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 << "Buffer: "
              << std::quoted(std::string_view{buffer.data(), min_buffer_size})
              << '\n';
 
    // Print the buffer directly after adding the trailing '\0'.
    buffer.push_back('\0');
    std::cout << "Buffer: " << std::quoted(buffer.data()) << '\n';
}

输出

Min buffer size = 37
Buffer: "Hubble's H₀ ≅ *42* miles/sec/mpc."
Buffer: "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)
通过输出迭代器写出其参数的格式化表示
(函数模板) [编辑]
通过输出迭代器写出其参数的格式化表示,不超过指定大小
(函数模板) [编辑]