advise

Crates.ioadvise
lib.rsadvise
version0.1.0
sourcesrc
created_at2024-04-21 04:00:01.390414
updated_at2024-04-21 04:00:01.390414
descriptionUser-friendly status reporting
homepage
repositoryhttps://github.com/kaplanz/advise
max_upload_size
id1215124
size33,366
Zakhary Kaplan (kaplanz)

documentation

https://docs.rs/advise

README

advise

latest version dependency status documentation license

About

This crate offers a streamlined way to keep users informed about your program's progress and potential issues. It provides:

  • Convenience macros: Advise at familiar logging levels error!, warn!, info!, debug!, and trace! to categorize your messages.
  • Customizable tags: Design your own message tags using the Render trait, tailoring the specific needs to your application.

Usage

advise provides a simple API, similar to the log crate, for printing status messages that should be enough for the majority of use-cases.

use advise::{info, warn};

fn main() {
    warn!("It's dangerous to go alone!");
    info!("Take this.");
}

Running the above code will print the following to stderr.

warn: It's dangeous to go alone!
info: Take this.

[!IMPORTANT]

GitHub currently does not support coloured text in markdown. You can run this example with cargo run --example=basic to see the above output rendered in colour.

License

This project is dual-licensed under both MIT License and Apache License 2.0. You have permission to use this code under the conditions of either license pursuant to the rights granted by the chosen license.

Commit count: 10

cargo fmt