use-api-error 0.0.1

Models error codes, messages, details, field errors, validation errors, retryability, categories, and protocol-neutral error envelopes.
Documentation
  • Coverage
  • 91.49%
    43 out of 47 items documented1 out of 36 items with examples
  • Size
  • Source code size: 12.11 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 2s Average build duration of successful builds.
  • all releases: 2s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • RustUse/use-api
    1 0 0
  • crates.io
  • Dependencies
    • —
  • Versions
  • Owners
  • CloudBranch

use-api-error

API error envelope primitives for RustUse.

Models error codes, messages, details, field errors, validation errors, retryability, categories, and protocol-neutral error envelopes.

Example

use use_api_error::{ErrorCategory, ErrorCode};

let value = ErrorCode::new("invalid-request").expect("valid API primitive");

assert_eq!(value.as_str(), "invalid-request");
assert_eq!(ErrorCategory::Validation.to_string(), "validation");

Scope

  • Small validated types for API metadata.
  • Stable display labels and conservative parsing helpers.
  • Dependency-light primitives that can be reused by other RustUse crates.

Non-goals

  • No framework response conversion.
  • No localization system.
  • No exception handling runtime.

License

Licensed under either of the following, at your option:

  • Apache License, Version 2.0
  • MIT license