std::basic_format_arg

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

实用程序库

语言支持 类型支持 (基本类型，RTTI) 库特性测试宏 (C++20) 动态内存管理 程序实用程序 协程支持 (C++20) 可变参数函数 is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) 调试支持 is_debugger_present (C++26) breakpoint_if_debugging (C++26) breakpoint (C++26) 三方比较 three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)    is_eqis_ltis_lteq (C++20)(C++20)(C++20) is_neqis_gtis_gteq (C++20)(C++20)(C++20)

通用实用程序 日期和时间 函数对象 格式化库 (C++20) bitset hash (C++11) 关系运算符 (C++20 中已弃用) rel_ops::operator!=rel_ops::operator>     rel_ops::operator<=rel_ops::operator>= 整数比较函数 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)    cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) 交换 和 类型操作 swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) 通用词汇类型 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) 基本字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

格式化库

标准格式规范

格式化函数

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。

注释

功能测试 宏	值	Std	功能
__cpp_lib_format	202306L	(C++26)	成员 visit

另请参阅

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

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