memoir 📝

Memoir is a powerful and flexible logging library for Rust that makes it easy to capture, record, and analyze events in your code. With its intuitive interface and rich features, Memoir is the ideal tool for developers who want to gain deeper insights into their applications.

Installation

You can use the package manager cargo to install memoir.

cargo install memoir-logger

or add it to your current project by also using cargo to install memoir.

cargo add memoir-logger

Usage

We provide a simple interface for memoir, to help users access a logging system as easily as possible. We provide simple functions to output each type of log level.

use memoir_logger::logging_utility::{FileLogger, LogLevel}; // Import everything needed from memoir.

fn main() {
    let mut f: FileLogger = FileLogger { // Initialize our FileLogger, and make sure it is mut.
        filepath: "current_log.log".to_string(),
        whitelist: vec![LogLevel::Warning, LogLevel::Info], // Filter what Logs you want to see.
        format: "[%d] %l - %m".to_string(), // Format of the outputted log.
    };
    f.warn("test".to_string()); // Output a warning log onto the filepath, if in whitelist.
    f.set_format("%l - %m".to_string()); // Sets a new format.
    f.info("test".to_string()); // Output an info log in a different format.
}

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT