std::format

< 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)
 
格式化库
格式化函数
format
(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)
(C++20)(C++20)
格式错误
(C++20)
 
定义于头文件 <format>
template<class... Args>
std::string format(std::string_view fmt, const Args&... args);
 (1) (C++20 起)
template<class... Args>
std::wstring format(std::wstring_view fmt, const Args&... args);
 (2) (C++20 起)
template<class... Args>
std::string format(const std::locale& loc, std::string_view fmt, const Args&... args);
 (3) (C++20 起)
template<class... Args>
std::wstring format(const std::locale& loc, std::wstring_view fmt, const Args&... args);
 (4) (C++20 起)

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

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

参数

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

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

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

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

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

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


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

返回值

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

异常

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

注解

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

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

示例

本节未完成
原因：暂无示例

参阅

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