bslfmt::basic_format_context< t_OUT, t_CHAR > Class Template Reference

#include <bslfmt_format_context.h>

Detailed Description

template<class t_OUT, class t_CHAR>
class bslfmt::basic_format_context< t_OUT, t_CHAR >

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.

See bslfmt_format_context

Public Types
typedef t_OUT	iterator
typedef t_CHAR	char_type

Public Member Functions
void	advance_to (iterator it)
iterator	out ()
Arg	arg (size_t id) const BSLS_KEYWORD_NOEXCEPT

Friends
class	Format_ContextFactory

Member Typedef Documentation

char_type

template<class t_OUT , class t_CHAR >

typedef t_CHAR bslfmt::basic_format_context< t_OUT, t_CHAR >::char_type

iterator

template<class t_OUT , class t_CHAR >

typedef t_OUT bslfmt::basic_format_context< t_OUT, t_CHAR >::iterator

Member Function Documentation

advance_to()

template<class t_OUT , class t_CHAR >

void bslfmt::basic_format_context< t_OUT, t_CHAR >::advance_to ( iterator  it )

inline

Update the contained iterator to that specified by it.

arg()

template<class t_OUT , class t_CHAR >

basic_format_context< t_OUT, t_CHAR >::Arg bslfmt::basic_format_context< t_OUT, t_CHAR >::arg ( size_t  id ) const

inline

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

template<class t_OUT , class t_CHAR >

basic_format_context< t_OUT, t_CHAR >::iterator bslfmt::basic_format_context< t_OUT, t_CHAR >::out ( )

inline

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 And Related Symbol Documentation

Format_ContextFactory

template<class t_OUT , class t_CHAR >

friend class Format_ContextFactory

friend

---

The documentation for this class was generated from the following files:

• bslfmt_format_arg.h
• bslfmt_format_context.h