Struct LogFormatter

pub struct LogFormatter { /* private fields */ }

Formats raw log structs into log messages by applying both the log message’s configuration and the formatter’s own settings.

Examples

Using a LogFormatter to print a log:

// Create a `LogFormatter` with default configuration
let mut formatter = LogFormatter::default();

// Set a log format
formatter.set_log_format("[ %h %m ]");

// Obtain a formatted log from a `LogStruct`
let log = formatter.format_log(&LogStruct::debug("Hello from LogStruct!"));

// Print the formatted log message
print!("{}", &log);

Implementations

impl LogFormatter

pub fn format_log(&mut self, log: &LogStruct) -> String

Returns a log entry from a LogStruct based on current LogFormatter configuration.

Examples

let mut formatter = LogFormatter::default();
let log_string = formatter.format_log(&LogStruct::error("Error!"));

pub fn enable_log_header_color(&mut self)

Enables the log headers to have colors.

pub fn disable_log_header_color(&mut self)

Disables colored log headers.

pub fn set_debug_color<I: Into<Color>>(&mut self, color: I)

Sets debug log header color.

pub fn set_info_color<I: Into<Color>>(&mut self, color: I)

Sets info log header color.

pub fn set_warning_color<I: Into<Color>>(&mut self, color: I)

Sets warning header color.

pub fn set_error_color<I: Into<Color>>(&mut self, color: I)

Sets error header color.

pub fn set_fatal_color<I: Into<Color>>(&mut self, color: I)

Sets fatal error header color.

pub fn set_debug_header(&mut self, header: &str)

Sets debug log header format.

pub fn set_info_header(&mut self, header: &str)

Sets info log header format.

pub fn set_warning_header(&mut self, header: &str)

Sets warning header format.

pub fn set_error_header(&mut self, header: &str)

Sets error header format.

pub fn set_fatal_header(&mut self, header: &str)

Sets fatal error header format.

pub fn set_datetime_format(&mut self, format: &str)

Sets datetime format.

pub fn set_log_format(&mut self, format: &str) -> Result<(), Error>

Sets the log format.

Returns an error when the %m placeholder is missing.

There are several placeholders in a log format string:

• %m: The log message (this placeholder is mandatory, you will get an error if you don’t include it in your log format).
• %h: The header indicating the log type (e.g., debug, error, etc.)
• %d: The timestamp.

You can have multiple placeholders of the same type in a format string.

Examples

let mut formatter = LogFormatter::default();

// Do a nice XML-like format
formatter.set_log_format("<l> <h>%h</h> <m>%m</m> </l>");
print!("{}", formatter.format_log(&LogStruct::debug("Hello, World!")));

Trait Implementations

impl Clone for LogFormatter

fn clone(&self) -> LogFormatter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LogFormatter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LogFormatter

fn default() -> LogFormatter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LogFormatter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for LogFormatter

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for LogFormatter

fn cmp(&self, other: &LogFormatter) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for LogFormatter

fn eq(&self, other: &LogFormatter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for LogFormatter

fn partial_cmp(&self, other: &LogFormatter) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for LogFormatter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for LogFormatter

impl StructuralPartialEq for LogFormatter