volo-http 0.5.5

HTTP framework implementation of volo.
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

//! Generic error types for server

use std::{error::Error, fmt};

use http::StatusCode;

use crate::{response::Response, server::IntoResponse};

/// [`Error`]s when extracting something from a [`Body`](crate::body::Body)
#[derive(Debug)]
#[non_exhaustive]
pub enum ExtractBodyError {
    /// Generic extracting errors when pulling [`Body`](crate::body::Body) or checking
    /// `Content-Type` of request
    Generic(GenericRejectionError),
    /// The [`Body`](crate::body::Body) cannot be extracted as a [`String`] or
    /// [`FastStr`](faststr::FastStr)
    String(simdutf8::basic::Utf8Error),
    /// The [`Body`](crate::body::Body) cannot be extracted as a json object
    #[cfg(feature = "json")]
    Json(crate::utils::json::Error),
    /// The [`Body`](crate::body::Body) cannot be extracted as a form object
    #[cfg(feature = "form")]
    Form(serde_urlencoded::de::Error),
}

impl fmt::Display for ExtractBodyError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str("failed to extract ")?;
        match self {
            Self::Generic(e) => write!(f, "data: {e}"),
            Self::String(e) => write!(f, "string: {e}"),
            #[cfg(feature = "json")]
            Self::Json(e) => write!(f, "json: {e}"),
            #[cfg(feature = "form")]
            Self::Form(e) => write!(f, "form: {e}"),
        }
    }
}

impl Error for ExtractBodyError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            Self::Generic(e) => Some(e),
            Self::String(e) => Some(e),
            #[cfg(feature = "json")]
            Self::Json(e) => Some(e),
            #[cfg(feature = "form")]
            Self::Form(e) => Some(e),
        }
    }
}

impl IntoResponse for ExtractBodyError {
    fn into_response(self) -> Response {
        let status = match self {
            Self::Generic(e) => e.to_status_code(),
            Self::String(_) => StatusCode::UNSUPPORTED_MEDIA_TYPE,
            #[cfg(feature = "json")]
            Self::Json(_) => StatusCode::BAD_REQUEST,
            #[cfg(feature = "form")]
            Self::Form(_) => StatusCode::BAD_REQUEST,
        };

        status.into_response()
    }
}

/// Generic rejection [`Error`]s
#[derive(Debug)]
#[non_exhaustive]
pub enum GenericRejectionError {
    /// Failed to collect the [`Body`](crate::body::Body)
    BodyCollectionError,
    /// The `Content-Type` is invalid for the extractor
    InvalidContentType,
}

impl fmt::Display for GenericRejectionError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::BodyCollectionError => write!(f, "failed to collect the response body"),
            Self::InvalidContentType => write!(f, "invalid content type"),
        }
    }
}

impl Error for GenericRejectionError {}

impl GenericRejectionError {
    /// Convert the [`GenericRejectionError`] to the corresponding [`StatusCode`]
    pub fn to_status_code(&self) -> StatusCode {
        match self {
            Self::BodyCollectionError => StatusCode::INTERNAL_SERVER_ERROR,
            Self::InvalidContentType => StatusCode::UNSUPPORTED_MEDIA_TYPE,
        }
    }
}

impl IntoResponse for GenericRejectionError {
    fn into_response(self) -> Response {
        self.to_status_code().into_response()
    }
}

/// Create a generic [`ExtractBodyError`] with [`GenericRejectionError::BodyCollectionError`]
pub fn body_collection_error() -> ExtractBodyError {
    ExtractBodyError::Generic(GenericRejectionError::BodyCollectionError)
}

/// Create a generic [`ExtractBodyError`] with [`GenericRejectionError::InvalidContentType`]
pub fn invalid_content_type() -> ExtractBodyError {
    ExtractBodyError::Generic(GenericRejectionError::InvalidContentType)
}