actix-error 0.2.11

A simple library to handle REST errors, with a derive macro to generate the error type. It also provides a compatibility layer with actix-web.
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

use std::fmt::{Display, Formatter, Debug};
use std::error::Error;
use serde::Serialize;
pub use actix_error_derive::AsApiError;

/// Represents a structured error that can be easily serialized and sent as an HTTP response.
#[derive(Debug, Clone, Serialize)]
pub struct ApiError {
    /// A machine-readable error type or category.
    pub kind: String,
    /// The HTTP status code associated with this error. This field is not serialized.
    #[serde(skip_serializing)]
    pub code: u16,
    /// A human-readable message describing the error.
    pub message: String,
    /// Optional structured details about the error.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub details: Option<serde_json::Value>,
}

impl ApiError {
    /// Creates a new `ApiError`.
    ///
    /// # Arguments
    ///
    /// * `code` - The HTTP status code for this error.
    /// * `kind` - A string slice representing the kind or category of the error.
    /// * `message` - A `String` containing the descriptive message for the error.
    /// * `details` - Optional `serde_json::Value` for structured error details.
    pub fn new(
        code: u16,
        kind: &str,
        message: String,
        details: Option<serde_json::Value>,
    ) -> Self {
        Self {
            kind: kind.to_string(),
            message,
            code,
            details,
        }
    }
}

/// A trait for types that can be converted into an `ApiError`.
pub trait AsApiErrorTrait {
    /// Converts the type into an `ApiError`.
    fn as_api_error(&self) -> ApiError;
}

impl Display for ApiError {
    fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
        write!(f, "{}: {}", self.kind, self.message)
    }
}

impl Error for ApiError {}

impl actix_web::ResponseError for ApiError {
    fn status_code(&self) -> actix_web::http::StatusCode {
        actix_web::http::StatusCode::from_u16(self.code)
            .unwrap_or(actix_web::http::StatusCode::INTERNAL_SERVER_ERROR)
    }

    fn error_response(&self) -> actix_web::HttpResponse {
        actix_web::HttpResponse::build(self.status_code()).json(self)
    }
}