Struct logging_rs::Formatter

pub struct Formatter {
    pub color_format_string: String,
    pub format_string: String,
    pub timestamp_format: String,
}

Logging formatter object.

Use Formatter::new() to create formatter objects instead of using this struct.

Parameters

• color_format_string: Format string supporting special ASCII control characters
• format_string: Format string NOT supporting special ASCII control characters
• timestamp_format: Timestamp format string in strftime format

Returns

A new Formatter object with the specified format strings.

Examples

logging_rs::Formatter {
    color_format_string: "format string with color support".to_owned(),
    format_string: "format string".to_owned(),
    timestamp_format: "timestamp format".to_owned()
};

Fields

color_format_string: String

Format string supporting special ASCII control characters

format_string: String

Format string NOT supporting special ASCII control characters

timestamp_format: String

Timestamp format string in strftime format

Implementations

impl Formatter

pub fn new( color_format_string: &str, format_string: &str, timestamp_format: &str ) -> Formatter

Creates a new formatter object.

Parameters

• color_format_string: Format string supporting special ASCII control characters
• format_string: Format string NOT supporting special ASCII control characters
• timestamp_format: Timestamp format string in strftime format

Returns

A new Formatter object with the specified format strings.

Examples

logging_rs::Formatter::new(
    "[{{color.bright_blue}}{{timestamp}}{{end}}] [{{level}}] {{path}}: {{message}}",
    "[{{timestamp}}] [{{level}}] {{path}}: {{message}}",
    "%Y-%m-%d %H:%M:%S"
);

See also

• Formatter

pub fn format<'a>( &self, output: Output, level: Level, message: &'a str, arguments: Vec<(&str, &'a str)> ) -> String

Formats the given message.

Parameters

• self: The formatter object
• output: The Output to write to
• level: The log Level to use for formatting
• message: The message to log
• arguments: A vector of additional formatting arguments

Returns

A String containing the formatted message.

Examples

formatter.format(
    logging_rs::Output::default(),
    logging_rs::Level::default(),
    "Some message with an {{argument}}",
    vec![("argument", "replaced value")]
);

See also

• Formatter
• Output
• Level

Trait Implementations

impl Clone for Formatter

fn clone(&self) -> Formatter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Formatter

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

Formats the value using the given formatter.

impl Default for Formatter

fn default() -> Formatter

Returns the “default value” for a type.

impl Hash for Formatter

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 Formatter

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Formatter

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Formatter

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Formatter

impl StructuralEq for Formatter

impl StructuralPartialEq for Formatter