A format context for use by formatter::parse() partial specialization. It provides access to iterators for the start and end of the remaining (unparsed) format string, as well as argument counters.

Synopsis

Declared in <bslfmt_formatparsecontext.h>

template<class t_CHAR>
class basic_format_parse_context;

Type Aliases

Name

Description

char_type

This typedef is an alias for the character type t_CHAR.

const_iterator

This typedef is an alias for a constant iterator over the format string.

iterator

This typedef is an alias for const_iterator.

Member Functions

Name

Description

basic_format_parse_context [constructor]

Constructors

advance_to

Update the held iterator to the unparsed portion of the format string to be the specified it. Subsequent calls to begin will return this value. The behavior is undefined unless it is a valid iterator to the format string used in construction of this context.

begin

Return an iterator to the start of the unparsed portion of the format string.

check_arg_id

Check that the specified id is a valid argument index. If the indexing mode is unset, the indexing mode is set to e_MANUAL. If the indexing mode is e_AUTOMATIC, caused by a previous call to next_arg_id then an exception of type format_error is thrown. If id is not less than the number of arguments then an exception of type format_error is thrown.

end

Return an iterator to the start of the unparsed portion of the format string.

next_arg_id

Return the index of the next‐unused argument. If the indexing mode is unset, the indexing mode is set to e_AUTOMATIC. If the indexing mode is e_MANUAL, caused by a previous call to check_arg_id then an exception of type format_error is thrown. If there are no remaining unused arguments then an exception of type format_error is thrown.

Created with MrDocs