err-rs 0.0.4

Error level management
Documentation
  • Coverage
  • 30%
    3 out of 10 items documented0 out of 6 items with examples
  • Size
  • Source code size: 6.15 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.54 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 10s Average build duration of successful builds.
  • all releases: 10s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • piot/err-rs
    0 0 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • piot

🚀 err-rs: Error Level Management

Welcome to err-rs! This library provides a simple and efficient way to categorize and handle different levels of errors in your applications.

đŸ› ī¸ Features

  • Error Levels: Define and categorize error severity with the ErrorLevel enum.
  • Trait for Error Level Providers: Implement the ErrorLevelProvider trait to easily retrieve error levels.
  • Utility Function: Use most_severe_error to determine the highest severity from a slice of error levels.

đŸ“Ļ Error Levels

The ErrorLevel enum provides three levels of error severity:

#[derive(Copy, Clone, Eq, PartialEq, Debug, Ord, PartialOrd)]
pub enum ErrorLevel {
    Info,     // â„šī¸ Informative, can be ignored
    Warning,  // âš ī¸ Should be logged, but recoverable
    Critical, // ❗ Requires immediate attention, unrecoverable
}

💡 Usage

To use the library, implement the ErrorLevelProvider trait in your structs or enums:

pub trait ErrorLevelProvider {
    fn error_level(&self) -> ErrorLevel;
}

🚀 Getting Started

To include err-rs in your project, add the following to your Cargo.toml:

[dependencies]
err-rs = "0.0.3"

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.