A structure containing the arguments to a log formatter. More...

#include <shambase/include/shambase/logs/reformat_message.hpp>

Collaboration diagram for shambase::logs::ReformatArgs:

Public Attributes
std::string	color
	The color of the log message.

const char *	level_name
	The name of the log level.

std::string	module_name
	The name of the module from which the log is emitter.

std::string	content
	The log message.

Detailed Description

A structure containing the arguments to a log formatter.

This structure is used to pass the arguments to a log formatter function. It contains the color of the log message, the name of the log level, the name of the module, and the log message itself.

Definition at line 29 of file reformat_message.hpp.

Member Data Documentation

◆ color

std::string shambase::logs::ReformatArgs::color

The color of the log message.

This is a string containing the color escape sequence for the log message. It may be empty if no color is desired.

Definition at line 36 of file reformat_message.hpp.

◆ content

std::string shambase::logs::ReformatArgs::content

The log message.

This is a string containing the log message. It may be empty if no message is desired.

Definition at line 60 of file reformat_message.hpp.

◆ level_name

const char* shambase::logs::ReformatArgs::level_name

The name of the log level.

This is a string containing the name of the log level. It may be empty if no log level is desired.

Definition at line 44 of file reformat_message.hpp.

◆ module_name

std::string shambase::logs::ReformatArgs::module_name

The name of the module from which the log is emitter.

This is a string containing the name of the module. It may be empty if no module name is desired.

Definition at line 52 of file reformat_message.hpp.

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