std::basic_format_parse_context

 

C++

Language

Standard Library Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Utilities library

Type support (basic types, RTTI, type traits)
Dynamic memory management
Error handling
Program utilities
Variadic functions
Library feature-test macros
Date and time
Function objects
Formatting library (C++20)
initializer_list (C++11)
source_location (C++20)
bitset
hash (C++11)
integer_sequence (C++14)
Relational operators (deprecated in C++20)
rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>=
Comparisons (C++20)
three_way_comparablethree_way_comparable_with
strong_ordering weak_ordering partial_ordering common_comparison_category compare_three_way_result compare_three_way	strong_order weak_order partial_order compare_strong_order_fallback compare_weak_order_fallback compare_partial_order_fallback	is_eqis_neqis_ltis_lteqis_gtis_gteq
Common vocabulary types
pair tuple (C++11) apply (C++17) make_from_tuple (C++17)	optional (C++17) any (C++17) variant (C++17)
Swap, forward and move
swap
exchange (C++14)
forward (C++11)
move (C++11)
move_if_noexcept (C++11)
Elementary string conversions
to_chars (C++17)
from_chars (C++17)
chars_format (C++17)
Type operations
declval (C++11)
as_const (C++17)
launder (C++17)

 

Formatting library

Formatting functions

format (C++20)

format_to (C++20)

format_to_n (C++20)

formatted_size (C++20)

vformat (C++20)

vformat_to (C++20)

Formatter

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)

Formatting arguments

basic_format_arg (C++20)

basic_format_argsformat_argswformat_argsformat_args_t (C++20)(C++20)(C++20)(C++20)

visit_format_arg (C++20)

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

Format error

format_error (C++20)

 

Defined in header <format>
template<class CharT> class basic_format_parse_context;	(1)	(since C++20)
using format_parse_context = basic_format_parse_context<char>;	(2)	(since C++20)
using wformat_parse_context = basic_format_parse_context<wchar_t>;	(3)	(since C++20)

Provides access to the format string parsing state consisting of the format string range being parsed and the argument counter for automatic indexing.

A basic_format_parse_context instance is passed to Formatter when parsing the format specification.

Member types

Type	Definition
char_type	CharT
iterator	std::basic_string_view<CharT>::const_iterator
const_iterator	std::basic_string_view<CharT>::const_iterator

Member functions

(constructor)	constructs a std::basic_format_parse_context instance from format string and argument count (public member function)
operator= [deleted]	std::basic_format_parse_context is not copyable (public member function)
begin	returns an iterator to the beginning of the format string range (public member function)
end	returns an iterator to the end of the format string range (public member function)
advance_to	advances the begin iterator to the given position (public member function)
next_arg_id	enters automatic indexing mode, and returns the next argument index (public member function)
check_arg_id	enters manual indexing mode, checks if the given argument index is in range (public member function)

std::basic_format_parse_context::basic_format_parse_context

constexpr explicit basic_format_parse_context(std::basic_string_view<CharT> fmt,                                               std::size_t num_args = 0) noexcept;	(1)
basic_format_parse_context(const basic_format_parse_context&) = delete;	(2)

1) Constructs a std::basic_format_parse_context instance. Initializes the format string range to [fmt.begin(), fmt.end()), and the argument count to num_args.

2) The copy constructor is deleted. std::basic_format_parse_context is not copyable.

std::basic_format_parse_context::begin

constexpr const_iterator begin() const noexcept;

Returns an iterator to the beginning of the format string range.

std::basic_format_parse_context::end

constexpr const_iterator end() const noexcept;

Returns an iterator to the end of the format string range.

std::basic_format_parse_context::advance_to

constexpr void advance_to(const_iterator it);

Sets the beginning of the format string range to it. After a call to advance_to, subsequent calls to begin() will return a copy of it.

The behavior is undefined if end() is not reachable from it.

std::basic_format_parse_context::next_arg_id

constexpr std::size_t next_arg_id();

Enters automatic argument indexing mode, and returns the next argument index, starting from 0.

If *this has already entered manual argument indexing mode, throws std::format_error.

std::basic_format_parse_context::check_arg_id

constexpr void check_arg_id(std::size_t id);

Enters manual argument indexing mode.

If *this has already entered automatic argument indexing mode, throws std::format_error.

If id is larger than or equal to the argument count provided in the constructor, the call is not a constant expression.