std::format

来自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)
 
格式化库
格式化函数
format
(C++20)
(C++20)
(C++20)
(C++20)
格式化概念
格式化器
(C++20)
格式化参数
(C++20) (C++26 中弃用)
格式错误
 
在标头 <format> 定义
template< class... Args >
std::string format( /*format_string<Args...>*/ fmt, const Args&... args );
(1) (C++20 起)
template< class... Args >
std::wstring format( /*wformat_string<Args...>*/ fmt, const Args&... args );
(2) (C++20 起)
template< class... Args >

std::string format( const std::locale& loc,

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

std::wstring format( const std::locale& loc,

                     /*wformat_string<Args...>*/ fmt, const Args&... args );
(4) (C++20 起)

按照格式字符串 fmt 格式化 args ,并返回作为 string 的结果。 loc 若存在,则用于本地环境特定的格式化。

若对 Args 中的任一 Tistd::formatter<Ti, CharT> 不满足格式化器 (Formatter) 要求则行为未定义,其中 CharT 是对重载 (1,3)char ,对重载 (2,4)wchar_t

参数

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

返回值

保有格式化结果的 string 对象。

异常

在分配失败时抛出 std::bad_alloc 。并且会传播任何格式化器所抛的异常。

注解

提供多于格式字符串所要求的参数不是错误:

std::format("{} {}!", "Hello", "world", "something"); // OK :产生 "Hello world!"

P2216R3 起,格式字符串不是常量表达式是错误。此情况下可使用 std::vformat

std::string f(std::string_view runtime_format_string) {
    // return std::format(runtime_format_string, "foo", "bar"); // 错误
    return std::vformat(runtime_format_string, std::make_format_args("foo", "bar")); // OK
}

示例

#include <format>
#include <iostream>
#include <string>
#include <string_view>
 
template <typename... Args>
std::string dyna_print(std::string_view rt_fmt_str, Args&&... args) {
    return std::vformat(rt_fmt_str, std::make_format_args(args...));
}
 
int main() {
    std::cout << std::format("Hello {}!\n", "world");
 
    std::string fmt;
    for (int i{}; i != 3; ++i) {
        fmt += "{} "; // 构造格式化字符串
        std::cout << fmt << " : ";
        std::cout << dyna_print(fmt, "alpha", 'Z', 3.14, "unused");
        std::cout << '\n';
    }
}

输出:

Hello world!
{}  : alpha 
{} {}  : alpha Z 
{} {} {}  : alpha Z 3.14

缺陷报告

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

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

参阅

(C++20)
通过输出迭代器写其参数的格式化表示
(函数模板)
通过输出迭代器写其参数的格式化表示,不超出指定的大小
(函数模板)