fastrust 0.3.1

A lightweight API framework built on top of Axum, inspired by FastAPI
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

//! Error types for the fastrust framework.

use std::fmt;

/// Error types for fastrust operations.
///
/// This enum represents the various error conditions that can occur
/// when using the fastrust framework.
#[derive(Debug, Clone)]
pub enum Error {
    /// Invalid route configuration (e.g., overlapping routes).
    RouteError(String),
    /// Invalid server configuration (e.g., invalid host/port).
    ServerError(String),
    /// Failed to parse socket address.
    AddressError(String),
    /// Failed to bind to the socket address.
    BindError(String),
    /// OpenAPI specification generation failed.
    OpenApiError(String),
    /// Internal error.
    Internal(String),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::RouteError(msg) => write!(f, "Route error: {msg}"),
            Error::ServerError(msg) => write!(f, "Server error: {msg}"),
            Error::AddressError(msg) => write!(f, "Address error: {msg}"),
            Error::BindError(msg) => write!(f, "Bind error: {msg}"),
            Error::OpenApiError(msg) => write!(f, "OpenAPI error: {msg}"),
            Error::Internal(msg) => write!(f, "Internal error: {msg}"),
        }
    }
}

impl std::error::Error for Error {}

/// Result type alias for fastrust operations.
///
/// This is a convenience type alias that uses [`Error`] as the error type.
pub type Result<T> = std::result::Result<T, Error>;