advise 0.1.0

User-friendly status reporting
Documentation
  • Coverage
  • 92.86%
    13 out of 14 items documented7 out of 13 items with examples
  • Size
  • Source code size: 32.89 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.73 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 14s Average build duration of successful builds.
  • all releases: 14s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • kaplanz/advise
    0 0 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • kaplanz

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.

[!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.