std::basic_format_arg

在标头 `<format>` 定义
template< class Context > class basic_format_arg;		(C++20 起)

提供到格式化参数的访问。

basic_format_arg 对象通常由 std::make_format_args 创建并通过 std::visit_format_arg 或 visit 成员函数 (C++26 起)访问。

basic_format_arg 对象表现为如同存储一个下列类型的 std::variant ：

std::monostate （仅若对象被默认构造）
bool
Context::char_type
int
unsigned int
long long int
unsigned long long int
float
double
long double
const Context::char_type*
std::basic_string_view<Context::char_type>
const void*
basic_format_arg::handle

成员类

handle

(C++20)

允许格式化用户定义类型的对象的类型擦除包装
(公开成员类)

成员函数

(构造函数) (C++20)	构造 `std::basic_format_arg` (公开成员函数)
operator bool (C++20)	检查当前对象是否保有格式化参数 (公开成员函数)
visit (C++26)	观览存储的格式化参数 (公开成员函数)

非成员函数

visit_format_arg

(C++20) (C++26 中弃用)

用户定义格式化器的参数观览接口
(函数模板)

std::basic_format_arg::basic_format_arg

basic_format_arg() noexcept;		(C++20 起)

默认构造函数。构造不保有格式化参数的 basic_format_arg 。存储的对象拥有 std::monostate 类型。

为创建保有格式化参数的 basic_format_arg ，必须使用 std::make_format_args 。

std::basic_format_arg::operator bool

explicit operator bool() const noexcept;		(C++20 起)

检查 *this 是否保有格式化参数。

若 *this 保有格式化参数（即存储的对象不拥有 std::monostate 类型）则返回 true ，否则返回 false 。

std::basic_format_arg::visit

template< class Visitor > decltype(auto) visit( this basic_format_arg arg, Visitor&& vis );	(1)	(C++26 起)
template< class R, class Visitor > R visit( this basic_format_arg arg, Visitor&& vis );	(2)	(C++26 起)

应用观览器 vis 到 arg 所含的对象。

visit 函数不修改在其上调用的 basic_format_arg 对象，因为在调用 vis 前会创建该对象的副本。

1) 等价于 return std::visit(std::forward<Visitor>(vis), v); ，其中 v 是 arg 中存储的 std::variant 。

2) 等价于 return std::visit<R>(std::forward<Visitor>(vis), v); ，其中 v 是 arg 中存储的 std::variant 。

注解

功能特性测试宏	值	标准	注释
`__cpp_lib_format`	202306L	(C++26)	`visit` 成员

示例

参阅

basic_format_argsformat_argswformat_args

(C++20)(C++20)(C++20)

提供对所有格式化参数的访问的类
(类模板)

编译器支持
自立实现与有宿主实现
语言
标准库
标准库标头
具名要求
功能特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用工具库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
技术规范
符号索引
外部库

格式化函数
format (C++20)
format_to (C++20)
format_to_n (C++20)
formatted_size (C++20)
vformat (C++20)
vformat_to (C++20)
格式化概念
formattable (C++23)
格式化器
formatter (C++20)
range_formatter (C++23)
basic_format_parse_contextformat_parse_contextwformat_parse_context (C++20)(C++20)(C++20)
basic_format_contextformat_contextwformat_context (C++20)(C++20)(C++20)
range_format (C++23)
format_kind (C++23)
格式化参数
basic_format_arg (C++20)
basic_format_arg::handle (C++20)
basic_format_argsformat_argswformat_args (C++20)(C++20)(C++20)
basic_format_stringformat_stringwformat_string (C++20)(C++20)(C++20)
visit_format_arg (C++20) (C++26 中弃用)
make_format_argsmake_wformat_args (C++20)(C++20)
格式错误
format_error (C++20)