std::basic_format_arg

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

文本处理库

本地化库

正则表达式库 (C++11)

格式化库 (C++20)

空终止序列工具

字节字符串

多字节字符串

宽字符串

原生数值转换

to_chars (C++17) to_chars_result (C++17) from_chars (C++17) from_chars_result (C++17) chars_format (C++17)

文本编码标识

text_encoding (C++26)

 

格式化库

标准格式规范

格式化函数

format (C++20)

format_to (C++20)

format_to_n (C++20)

formatted_size (C++20)

vformat (C++20)

vformat_to (C++20)

格式字符串

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

runtime_format (C++26)

格式化概念

formattable (C++23)

Formatter

formatter (C++20)

formatter<pair-or-tuple> (C++23)

formatter<range> (C++23)

range_formatter (C++23)

enable_nonlocking_formatter_optimization (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)

visit_format_arg (C++20) (在 C++26 中废弃)

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

格式错误

format_error (C++20)

 

定义于头文件 <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)

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