basic-logger 0.1.2

//! A basic logger for the log facade.
//!
//! Usage
//!
//! 1. Add the required dependencies to your `Cargo.toml`.
//! ```toml
//! [dependencies]
//! basic-logger = "0.1"
//! log = "0.4"
//! ```
//!
//! _Note:_ Coloured output will be enabled by default. You can remove this feature by disabling all features.
//! ```toml
//! [dependencies]
//! ...
//! basic-logger = { version = "0.1", default-features = false }
//! ```
//!
//! 2. Initialize the logger _(Do this as early as possible in your project)_.
//! ```rust
//! use basic_logger::BasicLogger;
//!
//! use log::info;
//!
//! fn main() {
//!     BasicLogger::new().init().unwrap();
//!
//!     info!("Hello, world!");
//! }
//! ```

#[cfg(feature = "colored")]
use colored::Colorize;

use log::{Level, LevelFilter, Log, Metadata, Record, SetLoggerError};

/// Implements [`log`] and a set of builder methods used for configuration.
///
/// Use the builder methods on this struct to configure the logger, then call [`init`] to initialize the actual logger.
pub struct BasicLogger {
    default_filter: LevelFilter,
}

impl BasicLogger {
    /// Initialize the logger with the default log level set to `Level::Trace`.
    pub fn new() -> Self {
        Self {
            default_filter: LevelFilter::Trace,
        }
    }

    /// Set the default log level.
    #[must_use = "You must call init() to begin logging"]
    pub fn with_level(mut self, level: LevelFilter) -> Self {
        self.default_filter = level;

        self
    }

    /// Initialize the actual logger.
    pub fn init(self) -> Result<(), SetLoggerError> {
        log::set_max_level(self.default_filter);
        log::set_boxed_logger(Box::new(self))?;

        Ok(())
    }
}

impl Default for BasicLogger {
    /// See [this](struct.BasicLogger.html#method.new)
    fn default() -> Self {
        BasicLogger::new()
    }
}

impl Log for BasicLogger {
    fn enabled(&self, metadata: &Metadata) -> bool {
        metadata.level() <= Level::Info
    }

    fn log(&self, record: &Record) {
        if self.enabled(record.metadata()) {
            let level = {
                #[cfg(feature = "colored")]
                match record.level() {
                    Level::Error => format!("[{}]", "-".red()),
                    Level::Info => format!("[{}]", "+".green()),
                    Level::Warn | Level::Debug | Level::Trace => format!("[{}]", "*".yellow()),
                }

                #[cfg(not(feature = "colored"))]
                match record.level() {
                    Level::Error => "[-]",
                    Level::Info => "[+]",
                    Level::Warn | Level::Debug | Level::Trace => "[*]",
                }
            };

            println!("{} {}", level, record.args());
        }
    }

    fn flush(&self) {}
}