Struct CatLoggr 

pub struct CatLoggr {
    pub level_map: HashMap<String, LogLevel>,
    /* private fields */
}

Fields

level_map: HashMap<String, LogLevel>

Implementations

impl CatLoggr

pub fn add_post_hook(&mut self, func: PostHookCallback) -> &mut Self

Adds a post hook, ran after formatting, but before final output The string returned by the hook will be the text after the level name.

Arguments

• func - The function to run

Examples

use cat_loggr::CatLoggr;
let mut logger = CatLoggr::new(None);

logger.add_post_hook(|params| -> Option<String> {
    let string: String = "New log".to_string();
    Some(string)
});

pub fn config(&mut self, options: Option<LoggrConfig>) -> &mut Self

Configures the logger

Arguments

• options - The options to configure with

Examples

// Configuring the levels

use cat_loggr::{CatLoggr, LogLevel, LoggrConfig};
let mut logger = CatLoggr::new(None);

logger.config(Some(LoggrConfig {
    levels: Some(vec![
        LogLevel   { name: "fatal".to_string(), style: owo_colors::Style::new().red().on_black(), position: None },
        LogLevel   { name: "info".to_string(), style: owo_colors::Style::new().red().on_black(), position: None }
    ]),
    color_enabled: false,
    ..LoggrConfig::default()
}));

pub fn new(options: Option<LoggrConfig>) -> Self

Creates an instance of the logger

Arguments

• options - The options to instantiate with

Examples

// Create with levels and shard ID

use cat_loggr::{CatLoggr, LoggrConfig, log_level::LogLevel};
let logger = CatLoggr::new(Some(LoggrConfig {
    levels: Some(vec![
        LogLevel   { name: "fatal".to_string(), style: owo_colors::Style::new().red().on_black(), position: None },
        LogLevel   { name: "info".to_string(), style: owo_colors::Style::new().red().on_black(), position: None }
    ]),
    shard: Some("123".to_string()),
    shard_length: Some(4),
    ..LoggrConfig::default()
}));

pub fn set_levels(&mut self, levels: Vec<LogLevel>) -> &mut Self

Overwrites the currently set levels with a custom set

Arguments

• levels - New levels to override with, in order from high to low priority

Examples

use cat_loggr::{CatLoggr, LogLevel};

let mut logger = CatLoggr::new(None);

logger.set_levels(vec![
    LogLevel   { name: "fatal".to_string(), style: owo_colors::Style::new().red().on_black(), position: None },
    LogLevel   { name: "info".to_string(), style: owo_colors::Style::new().red().on_black(), position: None }
]);

pub fn set_level(&mut self, level: &str) -> &mut Self

Sets the level threshold. Only logs on and above the threshold will be output

Arguments

• level - The name of the level threshold

pub fn log(&self, text: &str, level: &str) -> &Self

Writes the log

Arguments

• text - The text to write
• level - The level to write at

Examples

// Log to the `info` level

use cat_loggr::CatLoggr;
let logger = CatLoggr::new(None);

logger.log("This is a log", "info");

Trait Implementations

impl Default for CatLoggr

fn default() -> Self

Returns the “default value” for a type.