std::basic_format_context

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

工具库

语言支持 类型支持（基本类型、 RTTI 、类型特征）     库功能特性测试宏 (C++20) 动态内存管理 程序工具 错误处理 协程支持 (C++20) 变参数函数 launder (C++17) initializer_list (C++11) source_location (C++20) 三路比较 (C++20) 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_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

通用工具 日期和时间 函数对象 bitset 格式化库 (C++20) hash (C++11) integer_sequence (C++14) 关系运算符 (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 与类型运算 swap ranges::swap (C++20) exchange (C++14) declval (C++11) forward (C++11) move (C++11) move_if_noexcept (C++11) as_const (C++17) to_underlying (C++23) 常用词汇类型 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) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) 栈踪 stacktrace_entry (C++23) basic_stacktrace (C++23)

 

格式化库

格式化函数

format (C++20)

format_to (C++20)

format_to_n (C++20)

formatted_size (C++20)

vformat (C++20)

vformat_to (C++20)

格式化器

formatter (C++20)

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)

格式化参数

basic_format_arg (C++20)

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

visit_format_arg (C++20)

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 起)

提供到由格式化参数和输出迭代器组成的格式化状态的访问。

若 OutputIt 不实现 std::output_iterator<const CharT&> 则行为未定义。

2) 未指明的模板实参是后附到 std::string 的输出迭代器，例如 std::back_insert_iterator<std::string> 。鼓励实现使用到支持后附到任何连续存储且大小可变的容器的类型擦除缓冲。

3) 未指明的模板实参是后附到 std::wstring 的输出迭代器。

成员类型

类型	定义
iterator	OutputIt
char_type	CharT

成员别名模版

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

成员函数

arg	返回位于给定下标的参数 (公开成员函数)
locale	返回用于本地环境特定格式化的本地环境 (公开成员函数)
out	返回指向输出缓冲区的迭代器 (公开成员函数)
advance_to	推进输出迭代器到给定位置 (公开成员函数)

std::basic_format_context::arg

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

返回保有 args 中第 id 元素的 std::basic_format_arg ，其中 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 无法用于仅移动的迭代器类型	使之移动迭代器