Struct spirit_log::background::AsyncLogger

pub struct AsyncLogger { /* fields omitted */ }

A logger that postpones the logging into a background thread.

Note that to not lose messages, the logger need to be flushed.

Either manually:

log::logger().flush();

Or by dropping the FlushGuard (this is useful to flush even in non-success cases or as integrations with other utilities).

fn main() {
    let _guard = FlushGuard;
    // The rest of the application code.
}

Note that even with this, things like std::process::exit will allow messages to be lost.

Implementations

impl AsyncLogger

pub fn new(logger: Box<dyn Log>, buffer: usize, mode: OverflowMode) -> Self

Sends the given logger to a background thread.

Params

• logger: The logger to use in the background thread.
• buffer: How many messages there can be waiting in the channel to the background thread.
• mode: What to do if a message doesn't fit into the channel.

Panics

• If the buffer size is 0.
• If the AdaptiveDrop fill_limit is zero or larger or equal to buffer.

Trait Implementations

impl Drop for AsyncLogger

fn drop(&mut self)

Flushes the logger before going away, to make sure log messages are not lost.

As much as it's possible to ensure.

impl Log for AsyncLogger

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.