Struct fern::colors::ColoredLogLevelConfig

#[must_use = "builder methods take config by value and thus must be reassigned to variable"]
pub struct ColoredLogLevelConfig {
    pub error: Color,
    pub warn: Color,
    pub info: Color,
    pub debug: Color,
    pub trace: Color,
}

Configuration specifying colors a log level can be colored as.

Example usage setting custom 'info' and 'debug' colors:

use fern::colors::{Color, ColoredLogLevelConfig};

let colors = ColoredLogLevelConfig::new()
    .info(Color::Green)
    .debug(Color::Magenta);

fern::Dispatch::new()
    .format(move |out, message, record| {
        out.finish(format_args!(
            "[{}] {}",
            colors.color(record.level()),
            message
        ))
    })
    .chain(std::io::stdout())
    .apply()?;

Fields

error: Color

The color to color logs with the Error level.

warn: Color

The color to color logs with the Warn level.

info: Color

The color to color logs with the Info level.

debug: Color

The color to color logs with the Debug level.

trace: Color

The color to color logs with the Trace level.

Methods

impl ColoredLogLevelConfig

fn new() -> Self

Creates a new ColoredLogLevelConfig with the default colors.

This matches the behavior of ColoredLogLevelConfig::default.

fn error(self, error: Color) -> Self

Overrides the Error level color with the given color.

The default color is Color::Red.

fn warn(self, warn: Color) -> Self

Overrides the Warn level color with the given color.

The default color is Color::Yellow.

fn info(self, info: Color) -> Self

Overrides the Info level color with the given color.

The default color is Color::White.

fn debug(self, debug: Color) -> Self

Overrides the Debug level color with the given color.

The default color is Color::White.

fn trace(self, trace: Color) -> Self

Overrides the Trace level color with the given color.

The default color is Color::White.

fn default() -> Self

Retrieves the default configuration. This has:

• Error as Color::Red
• Warn as Color::Yellow
• Info as Color::White
• Debug as Color::White
• Trace as Color::White

fn color(&self, level: LogLevel) -> WithFgColor<LogLevel>

Colors the given log level with the color in this configuration corresponding to it's level.

The structure returned is opaque, but will print the LogLevel surrounded by ANSI color codes when displayed. This will work correctly for UNIX terminals, but due to a lack of support from the colored crate, this will not function in Windows.

fn get_color(&self, level: &LogLevel) -> Color

Retrieves the color that a log level should be colored as.

Trait Implementations

impl Copy for ColoredLogLevelConfig

impl Clone for ColoredLogLevelConfig

fn clone(&self) -> ColoredLogLevelConfig

Returns a copy of the value.

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

Performs copy-assignment from source.