rs-zero 0.2.6

Rust-first microservice framework inspired by go-zero engineering practices
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

use axum::response::IntoResponse;
use thiserror::Error;

use crate::rest::response::ApiResponse;

/// Result type used by REST helpers.
pub type RestResult<T> = Result<T, RestError>;

/// Errors returned by REST middleware and handlers.
#[derive(Debug, Error)]
pub enum RestError {
    #[error("unauthorized")]
    Unauthorized,

    #[error("request timed out")]
    Timeout,

    #[error("service unavailable: {0}")]
    ServiceUnavailable(String),

    #[error("concurrency limit reached")]
    ConcurrencyLimit,

    #[error("rate limit exceeded")]
    RateLimited,

    #[error("service overloaded")]
    Overloaded,

    #[error("bad request: {0}")]
    BadRequest(String),

    #[error("internal error: {0}")]
    Internal(String),
}

impl RestError {
    /// Stable error code for uniform JSON responses.
    pub fn code(&self) -> &'static str {
        match self {
            Self::Unauthorized => "UNAUTHORIZED",
            Self::Timeout => "TIMEOUT",
            Self::ServiceUnavailable(_) => "SERVICE_UNAVAILABLE",
            Self::ConcurrencyLimit => "CONCURRENCY_LIMIT",
            Self::RateLimited => "RATE_LIMITED",
            Self::Overloaded => "OVERLOADED",
            Self::BadRequest(_) => "BAD_REQUEST",
            Self::Internal(_) => "INTERNAL",
        }
    }
}

impl IntoResponse for RestError {
    fn into_response(self) -> axum::response::Response {
        ApiResponse::<()>::fail(self.code(), self.to_string()).into_response()
    }
}