ball_recordformatterfunctor

Detailed Description

Provide a typedef for the record formatter functor.

Outline

• Purpose
• Classes
• Description
  • Usage
    • Example 1: Defining a Record Formatter Function

Purpose

Provide a typedef for the record formatter functor.

Classes

• ball::RecordFormatterFunctor: struct containing formatter functor typedef

See also

ball_record, ball_recordformatterregistryutil

Description

This component provides a struct, ball::RecordFormatterFunctor, that contains a single typedef, Type, which is the type of the functor used for formatting log records to a stream.

Usage

This section illustrates intended use of this component.

Example 1: Defining a Record Formatter Function

Suppose we want to define a simple function that formats log records. We can use ball::RecordFormatterFunctor::Type to declare a functor that conforms to the expected signature.

First, we include the necessary headers and define a simple formatting function:

 void myFormatter(bsl::ostream& stream, const ball::Record& record)
 {
     stream << "Log: " << record.fixedFields().message();
 }

Then, we can assign this function to a variable of the functor type:

 ball::RecordFormatterFunctor::Type formatter = &myFormatter;

Finally, we can use this functor to format a record:

 ball::RecordAttributes attr;
 attr.setMessage("Hello");
 ball::Record record(attr, ball::UserFields());
 
 bsl::ostringstream oss;
 formatter(oss, record);
 assert(oss.str() == "Log: Hello");