Boost C++ Libraries

PrevUpHomeNext

Struct template formatter_types

boost::log::formatter_types — Auxiliary formatter traits.

Synopsis

// In header: <boost/log/utility/init/formatter_parser.hpp>

template<typename CharT> 
struct formatter_types {
  // types
  typedef CharT                                                                            char_type;               // Character type. 
  typedef std::basic_string< char_type >                                                   string_type;             // String type. 
  typedef std::basic_ostream< char_type >                                                  ostream_type;            // Output stream type. 
  typedef basic_record< char_type >                                                        record_type;             // Log record type. 
  typedef function2< void, ostream_type &, record_type const & >                           formatter_type;          // The formatter function object. 
  typedef std::map< string_type, string_type > formatter_factory_args;
  typedef function2< formatter_type, string_type const &, formatter_factory_args const & > formatter_factory;
  typedef std::map< string_type, formatter_factory >                                       factories_map;           // Map of formatter factory function objects. 
};

Description

The structure generates commonly used types related to formatters and formatter factories.

formatter_types public types

  1. typedef std::map< string_type, string_type > formatter_factory_args;

    Type of the map of formatter factory arguments [argument name -> argument value]. This type of maps will be passed to formatter factories on attempt to create a formatter.

  2. typedef function2< formatter_type, string_type const &, formatter_factory_args const & > formatter_factory;

    Throws: An std::exception-based If an exception is thrown from the method, the exception is propagated to the parse_formatter caller


PrevUpHomeNext