std::basic_format_arg<Context>::handle

 

C++

编译器支持

独立和宿主式

语言

标准库

标准库头文件

具名要求

特性测试宏 (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<Context>::handle;		(自 C++20 起)

一个类型擦除的包装器，允许格式化用户自定义类型的对象。

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

数据成员

handle 的典型实现是 TriviallyCopyable，并且仅存储两个非静态数据成员

• 一个 const void* 指针，指向要格式化的对象，以及
• 一个 void (*)(std::basic_format_parse_context<Context::char_type>&, Context&, const void*) 函数指针，指向在 format 成员函数中执行所需操作的函数（见下文）。

成员函数

format (C++20)

使用给定的上下文格式化引用的对象 (公有成员函数)

std::basic_format_arg<Context>::handle::format

void format( std::basic_format_parse_context<Context::char_type>& parse_ctx,              Context& format_ctx ) const;		(自 C++20 起)

设

• T 为格式化参数的类型，
• TD 为 std::remove_const_t<T>，
• TQ 为 const TD，如果 const TD 满足 __formattable_with<Context>，否则为 TD，并且
• ref 为格式化参数的引用。

等价于： typename Context::template formatter_type<TD> f;
parse_ctx.advance_to(f.parse(parse_ctx));
format_ctx.advance_to(f.format(const_cast<TQ&>(static_cast<const TD&>(ref)), format_ctx));

注释

handle 对于格式化参数具有引用语义，并且不延长其生命周期。程序员有责任确保参数的生命周期长于 handle。通常，handle 仅在格式化函数内部使用。

参见

basic_format_arg (C++20)	类模板，为用户定义的格式化器提供对格式化参数的访问 (类模板)
make_format_argsmake_wformat_args (C++20)(C++20)	创建一个类型擦除的对象，引用所有格式化参数，可转换为 format_args (函数模板)