std::formatted_size

< cpp‎ | utility‎ | format
 
C++
 
工具库
通用工具
日期和时间
函数对象
格式化库 (C++20)
(C++11)
(C++14)
关系运算符 (C++20 中弃用)
整数比较函数
(C++20)(C++20)(C++20)(C++20)(C++20)(C++20)
(C++20)
swap 与类型运算
(C++20)
(C++14)
(C++11)
(C++11)
(C++11)
(C++11)
(C++17)
常用词汇类型
(C++11)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)

初等字符串转换
(C++17)
(C++17)
(C++17)
 
格式化库
格式化函数
(C++20)
(C++20)
(C++20)
formatted_size
(C++20)
(C++20)
(C++20)
格式化器
(C++20)
(C++20)(C++20)(C++20)
(C++20)(C++20)(C++20)
格式化参数
(C++20)
(C++20)(C++20)(C++20)(C++20)
(C++20)
(C++20)(C++20)
格式错误
(C++20)
 
定义于头文件 <format>
template<class... Args>
std::size_t formatted_size(std::string_view fmt, const Args&... args);
 (1) (C++20 起)
template<class... Args>
std::size_t formatted_size(std::wstring_view fmt, const Args&... args);
 (2) (C++20 起)
template<class... Args>
std::size_t formatted_size(const std::locale& loc, std::string_view fmt, const Args&... args);
 (3) (C++20 起)
template<class... Args>
std::size_t formatted_size(const std::locale& loc, std::wstring_view fmt, const Args&... args);
 (4) (C++20 起)

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

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

参数

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

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

  • 引入的 { 字符；
  • (可选) arg-id ，一个非负数；
  • (可选) 冒号（ : ）后随格式说明；
  • 终止的 } 字符。

arg-id 指定用于格式化其值的 args 中的参数的下标；若省略 arg-id ，则按顺序使用参数。格式字符串中的 arg-id 必须全部存在或全部被省略。混合手动和自动指定下标是错误。

格式说明由对应参数特化的 std::formatter 定义。

  • 对于基本类型和标准字符串类型，格式说明为标准格式说明；
  • 对于标准日期和时间类型，格式说明为 chrono 格式说明；
  • 对于用户定义类型，格式说明由用户定义的 std::formatter 特化决定。


args... - 要格式化的参数
loc - 用于本地环境特定的格式化的 std::locale

返回值

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

异常

若 fmt 对于提供的参数不是合法的格式字符串则抛出 std::format_error 。并且会传播格式化器所抛的任何异常。

示例

运行此代码
#include <format>
#include <iostream>
#include <vector>
#include <string_view>
 
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 { "₀"sv };  // { "\u2080"sv } => { 0xe2, 0x82, 0x80 };
    constexpr auto aprox_equ { "≅"sv }; // { "\u2245"sv } => { 0xe2, 0x89, 0x85 };
    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';
 
    // 以 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 << "Buffer: \"" << std::string_view{buffer.data(), min_buffer_size} << "\"\n";
 
    // 或者我们能通过添加尾随 '\0' 直接打印缓冲区。
    buffer.push_back('\0');
    std::cout << "Buffer: \"" << buffer.data() << "\"\n";
}

输出： 

Min buffer size = 37
Buffer: "Hubble's H₀ ≅ *42* miles/sec/mpc."
Buffer: "Hubble's H₀ ≅ *42* miles/sec/mpc."

参阅