Struct bp3d_logger::Logger

pub struct Logger { /* private fields */ }

The base logger builder/initializer.

Examples

The following example shows basic initialization of this logger.

use bp3d_logger::Logger;
use log::info;
use log::LevelFilter;

fn main() {
    Logger::new().add_stdout().add_file("my-app").run(|| {
        log::set_max_level(LevelFilter::Info);
        //...
        info!("Example message");
    });
}

The following example shows initialization of this logger with a return value.

use bp3d_logger::Logger;
use log::info;
use log::LevelFilter;

fn main() {
    let code = Logger::new().add_stdout().add_file("my-app").run(|| {
        log::set_max_level(LevelFilter::Info);
        //...
        info!("Example message");
        0
    });
    std::process::exit(code);
}

The following example shows initialization of this logger and use of the log buffer.

use bp3d_logger::Logger;
use log::info;
use log::LevelFilter;

fn main() {
    Logger::new().add_stdout().add_file("my-app").run(|| {
        log::set_max_level(LevelFilter::Info);
        bp3d_logger::enable_log_buffer(); // Enable log redirect pump into application channel.
        //... application code with log redirect pump.
        info!("Example message");
        let l = bp3d_logger::get_log_buffer().recv().unwrap();// Capture the last log message.
        println!("Last log message: {}", l.msg);
        bp3d_logger::disable_log_buffer();
        //... application code without log redirect pump.
    });
}

Implementations

impl Logger

pub fn new() -> Logger

Creates a new instance of a logger builder.

pub fn add_stdout(self) -> Self

Enables stdout logging with automatic redirection of error logs to stderr.

pub fn add_file<T: GetLogs>(self, app: T) -> Self

Enables file logging to the given application.

The application is given as a reference to GetLogs to allow obtaining a log directory from various sources.

If the log directory could not be found the function prints an error to stderr.

pub fn run<R, F: FnOnce() -> R>(self, f: F) -> R

Initializes the log implementation with this current configuration.

NOTE: This takes a closure to flush all log buffers before returning. It is necessary to manually flush log buffers because this implementation uses threads to avoid blocking the main thread when issuing logs.

NOTE 2: There are no safety concerns with running twice this function in the same application, only that calling this function may be slow due to thread management.

Trait Implementations

impl Default for Logger

fn default() -> Logger

Returns the “default value” for a type.