Struct r3bl_simple_logger::TermLogger

pub struct TermLogger { /* private fields */ }

The TermLogger struct. Provides a stderr/out based Logger implementation

Supports colored output

Implementations

impl TermLogger

pub fn init( log_level: LevelFilter, config: Config, mode: TerminalMode, color_choice: ColorChoice ) -> Result<(), SetLoggerError>

init function. Globally initializes the TermLogger as the one and only used log facility.

Takes the desired Level and Config as arguments. They cannot be changed later on. Fails if another Logger was already initialized

Examples

    TermLogger::init(
        LevelFilter::Info,
        Config::default(),
        TerminalMode::Mixed,
        ColorChoice::Auto
    );

Examples found in repository

examples/default_colors.rs (lines 22-27)

fn main() {
    TermLogger::init(
        LevelFilter::Trace,
        Config::default(),
        TerminalMode::Stdout,
        ColorChoice::Auto,
    )
    .unwrap();
    error!("Red error");
    warn!("Yellow warning");
    info!("Blue info");
    debug!("Cyan debug");
    trace!("White trace");
}

examples/custom_colors.rs (lines 27-32)

fn main() {
    let config = ConfigBuilder::new()
        .set_level_color(Level::Error, Some(Color::Magenta))
        .set_level_color(Level::Trace, Some(Color::Green))
        .build();

    TermLogger::init(
        LevelFilter::Trace,
        config,
        TerminalMode::Stdout,
        ColorChoice::Auto,
    )
    .unwrap();
    error!("Magenta error");
    warn!("Yellow warning");
    info!("Blue info");
    debug!("Cyan debug");
    trace!("Green trace");
}

examples/rgb_colors.rs (lines 31-36)

fn main() {
    let config = ConfigBuilder::new()
        .set_level_color(Level::Error, Some(Color::Rgb(191, 0, 0)))
        .set_level_color(Level::Warn, Some(Color::Rgb(255, 127, 0)))
        .set_level_color(Level::Info, Some(Color::Rgb(192, 192, 0)))
        .set_level_color(Level::Debug, Some(Color::Rgb(63, 127, 0)))
        .set_level_color(Level::Trace, Some(Color::Rgb(127, 127, 255)))
        .build();

    TermLogger::init(
        LevelFilter::Trace,
        config,
        TerminalMode::Stdout,
        ColorChoice::Auto,
    )
    .unwrap();
    error!("Red error");
    warn!("Orange warning");
    info!("Yellow info");
    debug!("Dark green debug");
    trace!("Light blue trace");
}

pub fn new( log_level: LevelFilter, config: Config, mode: TerminalMode, color_choice: ColorChoice ) -> Box<TermLogger>

allows to create a new logger, that can be independently used, no matter whats globally set.

no macros are provided for this case and you probably don’t want to use this function, but init(), if you don’t want to build a CombinedLogger.

Takes the desired Level and Config as arguments. They cannot be changed later on.

Returns a Boxed TermLogger

Examples

let term_logger = TermLogger::new(
    LevelFilter::Info,
    Config::default(),
    TerminalMode::Mixed,
    ColorChoice::Auto
);

Examples found in repository

examples/usage.rs (lines 22-27)

fn main() {
    CombinedLogger::init(vec![TermLogger::new(
        LevelFilter::Warn,
        Config::default(),
        TerminalMode::Mixed,
        ColorChoice::Auto,
    )])
    .unwrap();

    error!("Bright red error");
    info!("This only appears in the log file");
    debug!("This level is currently not enabled for any logger");
}

Trait Implementations

impl Log for TermLogger

fn enabled(&self, metadata: &Metadata<'_>) -> bool

Determines if a log message with the specified metadata would be logged.

fn log(&self, record: &Record<'_>)

Logs the Record.

fn flush(&self)

Flushes any buffered records.

impl SharedLogger for TermLogger

fn level(&self) -> LevelFilter

Returns the set Level for this Logger

fn config(&self) -> Option<&Config>

Inspect the config of a running Logger

fn as_log(self: Box<Self>) -> Box<dyn Log>

Returns the logger as a Log trait object