breadcrumbs

Breadcrumbs is a beautiful, dynamic traceback and logging library for Rust that offers seamless integration with #![no_std], multi-threading and concurrency.

Features

• #![no_std] support
• Multi-threading and concurrency support
• Live streaming of logs
• Customisable log handling
• Varied logging levels
• Customisable logging 'channels'
• Out-of-the-box traceback and log formatting

Usage

Add the following to your Cargo.toml:

[dependencies]
breadcrumbs = "0.1.0"

Then, initalize breadcrumbs once in your main.rs or lib.rs:

use breadcrumbs::init;

init();

You can set a custom log handler with ease by implementing the LogHandler trait:

use breadcrumbs::{init_with_handler, LogHandler};
struct MyLogHandler;
 
impl LogHandler for MyLogHandler {
    fn on_log(&mut self, log: breadcrumbs::Log) {
       println!("{}", log);
    }
}
 
init_with_handler(Box::new(MyLogHandler));

Then, simply use the log! macro or its variants to log messages:

use breadcrumbs::{log, log_level, log_channel, LogLevel};

// A basic log message
log!("Hello, world!");

// A log message with a custom level
log_level!(LogLevel::Info, "Test log message");

// A log message with a custom channel
log_channel!("test_channel", "Test log message");

// A log message with a custom channel and level
log!(LogLevel::Info, "test_channel", "Test log message");

Access a traceback of log messages from anywhere with the traceback! macro or its variants:

use breadcrumbs::{traceback, traceback_channel, traceback_level, LogLevel};

// A basic traceback, fetching all logged messages
let t = traceback!();

// A traceback with a custom channel, fetching messages in this channel
let t = traceback_channel!("my-channel");

// A traceback with a custom level, fetching messages of this level or higher
let traceback = traceback_level!(LogLevel::Warn);

// A traceback with a custom channel and level, fetching messages in this channel of this level or higher
let traceback = traceback!(LogLevel::Warn, "test_channel");

Traceback and Log objects beautifully implement Display and Debug:

use breadcrumbs::traceback;

let t = traceback!();
println!("{}", t);

Example

use breadcrumbs::{init, log, log_level, log_channel, traceback, LogLevel};

fn main() {
    init();

    log!("Hello, world!");
    log_level!(LogLevel::Info, "Test log message");
    log_channel!("test_channel", "Test log message");
    log!(LogLevel::Info, "test_channel", "Test log message");
}

#[cfg(test)]
#[panic_handler]
fn panic(info: &core::panic::PanicInfo) -> ! {
    log!(LogLevel::Critical, "PANIC!");

    let t = traceback!();
    println!("{}", t);

    loop {}
}