std::basic_format_context

 

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 OutputIt, class CharT > class basic_format_context;	(1)	(自 C++20 起)
using format_context = basic_format_context</* unspecified */, char>;	(2)	(自 C++20 起)
using wformat_context = basic_format_context</* unspecified */, wchar_t>;	(3)	(自 C++20 起)

提供对格式化状态的访问，该状态包含格式化参数和输出迭代器。

2) 未指定的模板参数是一个输出迭代器，它追加到 std::string，例如 std::back_insert_iterator<std::string>。实现通常使用迭代器来对支持追加到任何连续且可调整大小的容器的类型擦除缓冲区类型进行类型化。

3) 未指定的模板参数是一个输出迭代器，它追加到 std::wstring。

如果 OutputIt 不符合 std::output_iterator<const CharT&> 的模型，则行为是未定义的。

显式或部分特化 std::basic_format_context 的程序是非法的，无需诊断。

std::basic_format_context 对象只能由实现创建。用户代码只允许通过 std::formatter 特化的 format 函数修改格式上下文。

成员类型

类型	定义
iterator	OutputIt
char_type	CharT

成员别名模板

类型	定义
formatter_type<T>	std::formatter<T, CharT>

成员函数

(构造函数) [已删除]	basic_format_context 不能由用户代码构造 (公有成员函数)
operator= [已删除]	basic_format_context 不可赋值 (公有成员函数)
arg	返回给定索引处的参数 (公有成员函数)
locale	返回用于特定于区域设置的格式化的区域设置 (公有成员函数)
out	返回输出缓冲区的迭代器 (公有成员函数)
advance_to	将输出迭代器推进到给定位置 (公有成员函数)

std::basic_format_context::arg

std::basic_format_arg<basic_format_context> arg( std::size_t id ) const;

返回一个 std::basic_format_arg，其中包含 args 中的第 id 个参数，其中 args 是传递给格式化函数的参数包或 std::basic_format_args 对象。

如果 id 不小于格式化参数的数量，则返回一个默认构造的 std::basic_format_arg（包含一个 std::monostate 对象）。

std::basic_format_context::locale

std::locale locale();

返回传递给格式化函数的区域设置，或者如果格式化函数不接受区域设置，则返回一个默认构造的 std::locale。

std::basic_format_context::out

iterator out();

返回输出缓冲区的迭代器。结果是从存储的迭代器移动构造的。

std::basic_format_context::advance_to

void advance_to( iterator it );

将 it 移动赋值给存储的输出迭代器。在调用 advance_to 之后，下次调用 out() 将返回一个迭代器，该迭代器具有 it 在赋值之前所具有的值。

缺陷报告

以下行为更改的缺陷报告已追溯应用于以前发布的 C++ 标准。

DR	应用于	已发布的行为	正确行为
LWG 3567	C++20	basic_format_context 不支持移动限定迭代器类型	修改为移动迭代器
LWG 3975	C++20	允许用户对 basic_format_context 进行特殊化	禁止
LWG 4061	C++20	basic_format_context 可以由用户代码构造和赋值	修改为不可构造也不可赋值