rskit-errors 0.2.0-alpha.2

Structured application error types with HTTP status mapping
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

//! Structured application error types with HTTP status mapping.
//!
//! # Examples
//!
//! ```rust
//! use rskit_errors::{AppError, AppResult, ErrorCode};
//!
//! fn find_user(id: &str) -> AppResult<String> {
//!     Err(AppError::not_found("user", Some(id))
//!         .context("find_user"))
//! }
//!
//! let err = find_user("abc").unwrap_err();
//! assert_eq!(err.code(), ErrorCode::NotFound);
//! assert!(err.message().contains("find_user"));
//! ```

#![warn(missing_docs)]

/// Machine-readable error classification codes.
pub mod code;
/// Conversions between [`AppError`] and HTTP status types.
pub mod convert;
/// Structured [`AppError`] type with rich context.
pub mod error;
/// RFC 9457 Problem Details response type.
pub mod response;

pub use code::ErrorCode;
pub use error::AppError;
pub use response::{ProblemDetail, type_base_uri};

/// Convenience alias used throughout rskit crates.
pub type AppResult<T> = Result<T, AppError>;