Struct bp3d_logger::Logger

pub struct Logger { /* private fields */ }

The main Logger type allows to control the entire logger state and submit messages for logging.

Implementations

impl Logger

pub fn enable_stdout(&self, flag: bool)

Enables the stdout/stderr logger.

Arguments

• flag: true to enable stdout, false to disable stdout.

pub fn raw_log(&self, msg: &LogMsg)

Low-level log function. This injects log messages directly into the logging thread channel.

This function applies basic formatting depending on the backend:

• For stdout/stderr backend the format is <target> [level] msg.
• For file backend the format is [level] msg and the message is recorded in the file corresponding to the log target.

WARNING: For optimization reasons, this function does not check and thus does neither honor the enabled flag nor the current log level. For a checked log function, use checked_log.

pub fn log(&self, msg: &LogMsg)

Main log function. This injects log messages into the logging thread channel only if this logger is enabled.

This function calls the raw_log function only when this logger is enabled.

pub fn filter(&self) -> LevelFilter

Returns the filter level of this logger instance.

pub fn set_filter(&self, filter: LevelFilter)

Sets the new level filter for this logger.

Arguments

• filter: the new LevelFilter.

pub fn is_enabled(&self) -> bool

Returns true if the logger is currently enabled and is capturing log messages.

pub fn flush(&self)

Flushes all pending messages.

Trait Implementations

impl Drop for Logger

fn drop(&mut self)

Executes the destructor for this type.