axum-anyhow 0.11.0

Ergonomic error handling for Axum using anyhow
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
35
36
37
38
39
40
41
42
43
44
45
46

#![doc = include_str!("../README.md")]

mod context;
mod error;
mod extensions;
mod helpers;
mod hook;
mod middleware;

pub use context::ApiErrorContext;
pub use error::{is_expose_errors_enabled, set_expose_errors, ApiError, ApiErrorBuilder};
pub use extensions::{IntoApiError, OptionExt, ResultExt};
pub use helpers::{
    bad_gateway, bad_request, conflict, forbidden, gateway_timeout, internal_error,
    method_not_allowed, not_found, service_unavailable, too_many_requests, unauthorized,
    unprocessable_entity,
};
pub use hook::on_error;
pub use middleware::ErrorInterceptorLayer;

use anyhow::Result;

/// A type alias for `Result<T, ApiError>`.
///
/// Use this as the return type for Axum handlers to automatically convert errors
/// into HTTP responses.
///
/// # Example
///
/// ```rust
/// use axum::Json;
/// use axum_anyhow::ApiResult;
/// use serde::Serialize;
///
/// #[derive(Serialize)]
/// struct Response {
///     message: String,
/// }
///
/// async fn handler() -> ApiResult<Json<Response>> {
///     Ok(Json(Response {
///         message: "Success".to_string(),
///     }))
/// }
/// ```
pub type ApiResult<T> = Result<T, ApiError>;