WPILibC++ 2024.3.1
basic_format_context< OutputIt, Char > Class Template Reference

#include </home/runner/work/allwpilib/allwpilib/wpiutil/src/main/native/thirdparty/fmtlib/include/fmt/core.h>

Public Types

using iterator = OutputIt
 
using format_arg = basic_format_arg< basic_format_context >
 
using format_args = basic_format_args< basic_format_context >
 
using parse_context_type = basic_format_parse_context< Char >
 
template<typename T >
using formatter_type = formatter< T, Char >
 
using char_type = Char
 The character type for the output. More...
 

Public Member Functions

 basic_format_context (basic_format_context &&)=default
 
 basic_format_context (const basic_format_context &)=delete
 
void operator= (const basic_format_context &)=delete
 
constexpr basic_format_context (OutputIt out, format_args ctx_args, detail::locale_ref loc={})
 Constructs a basic_format_context object. More...
 
constexpr auto arg (int id) const -> format_arg
 
FMT_CONSTEXPR auto arg (basic_string_view< Char > name) -> format_arg
 
FMT_CONSTEXPR auto arg_id (basic_string_view< Char > name) -> int
 
auto args () const -> const format_args &
 
FMT_CONSTEXPR auto error_handler () -> detail::error_handler
 
void on_error (const char *message)
 
FMT_CONSTEXPR auto out () -> iterator
 
void advance_to (iterator it)
 
FMT_CONSTEXPR auto locale () -> detail::locale_ref
 

Member Typedef Documentation

◆ char_type

template<typename OutputIt , typename Char >
using basic_format_context< OutputIt, Char >::char_type = Char

The character type for the output.

◆ format_arg

template<typename OutputIt , typename Char >
using basic_format_context< OutputIt, Char >::format_arg = basic_format_arg<basic_format_context>

◆ format_args

template<typename OutputIt , typename Char >
using basic_format_context< OutputIt, Char >::format_args = basic_format_args<basic_format_context>

◆ formatter_type

template<typename OutputIt , typename Char >
template<typename T >
using basic_format_context< OutputIt, Char >::formatter_type = formatter<T, Char>

◆ iterator

template<typename OutputIt , typename Char >
using basic_format_context< OutputIt, Char >::iterator = OutputIt

◆ parse_context_type

template<typename OutputIt , typename Char >
using basic_format_context< OutputIt, Char >::parse_context_type = basic_format_parse_context<Char>

Constructor & Destructor Documentation

◆ basic_format_context() [1/3]

template<typename OutputIt , typename Char >
basic_format_context< OutputIt, Char >::basic_format_context ( basic_format_context< OutputIt, Char > &&  )
default

◆ basic_format_context() [2/3]

template<typename OutputIt , typename Char >
basic_format_context< OutputIt, Char >::basic_format_context ( const basic_format_context< OutputIt, Char > &  )
delete

◆ basic_format_context() [3/3]

template<typename OutputIt , typename Char >
constexpr basic_format_context< OutputIt, Char >::basic_format_context ( OutputIt  out,
format_args  ctx_args,
detail::locale_ref  loc = {} 
)
inlineconstexpr

Constructs a basic_format_context object.

References to the arguments are stored in the object so make sure they have appropriate lifetimes.

Member Function Documentation

◆ advance_to()

template<typename OutputIt , typename Char >
void basic_format_context< OutputIt, Char >::advance_to ( iterator  it)
inline

◆ arg() [1/2]

template<typename OutputIt , typename Char >
FMT_CONSTEXPR auto basic_format_context< OutputIt, Char >::arg ( basic_string_view< Char >  name) -> format_arg
inline

◆ arg() [2/2]

template<typename OutputIt , typename Char >
constexpr auto basic_format_context< OutputIt, Char >::arg ( int  id) const -> format_arg
inlineconstexpr

◆ arg_id()

template<typename OutputIt , typename Char >
FMT_CONSTEXPR auto basic_format_context< OutputIt, Char >::arg_id ( basic_string_view< Char >  name) -> int
inline

◆ args()

template<typename OutputIt , typename Char >
auto basic_format_context< OutputIt, Char >::args ( ) const -> const format_args&
inline

◆ error_handler()

template<typename OutputIt , typename Char >
FMT_CONSTEXPR auto basic_format_context< OutputIt, Char >::error_handler ( ) -> detail::error_handler
inline

◆ locale()

template<typename OutputIt , typename Char >
FMT_CONSTEXPR auto basic_format_context< OutputIt, Char >::locale ( ) -> detail::locale_ref
inline

◆ on_error()

template<typename OutputIt , typename Char >
void basic_format_context< OutputIt, Char >::on_error ( const char *  message)
inline

◆ operator=()

template<typename OutputIt , typename Char >
void basic_format_context< OutputIt, Char >::operator= ( const basic_format_context< OutputIt, Char > &  )
delete

◆ out()

template<typename OutputIt , typename Char >
FMT_CONSTEXPR auto basic_format_context< OutputIt, Char >::out ( ) -> iterator
inline

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