A format context for use by formatter::format() partial specialization. It provides access to the output iterator for writing the formatted value and access to all formatting arguments.

Synopsis

Declared in <bslfmt_format_context.h>

template<
    class t_OUT,
    class t_CHAR>
class basic_format_context;

Type Aliases

Name

Description

char_type

This typedef is an alias for the character type t_CHAR.

formatter_type

Alias for bsl::formatter specialized on t_TYPE and t_CHAR.

iterator

This typedef is an alias for the output iterator type t_OUT.

Member Functions

Name

Description

advance_to

Update the contained iterator to that specified by it.

arg

Return a basic_format_arg type for the argument in the position specified by id, with indexing starting at zero. If id is not less than the number of contained arguments, a default‐constructed basic_format_arg object is returned.

out

Return (by value) the contained output iterator. As this is returned by value, any changes will not be reflected in the contained iterator unless a subsequent call to advance_to is made.

Friends

Name

Description

BloombergLP::bslfmt::Format_ContextFactory

This class provides utility functions to enable manipulation of types declared by this component. It is solely for private use by other components of the bslfmt package and should not be used directly.

Created with MrDocs