axum_responses 0.1.2

A Simple way to use Axum responses
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


use crate::to_http_status;
use serde_json::{json, Value};

use axum::{
    
    Json, response::{
        IntoResponse, 
        Response as HttpResponse
    }, 
};

/// `AxumResponse` data type that represents an HTTP response.
 
pub type AxumResponse = Result<Response, Response>;

/// `AxumResult` data type that represents a response 
/// from some service in the API.
/// 
/// ### Parameters
/// 
/// * `T`: Data type of the response.
/// 
/// ### Example
/// Returns a type T if the response is successful, 
/// otherwise it returns a negative `ApiResponse`, 
/// that is, an error HttpResponse.
 
pub type AxumResult<T> = Result<T, Response>;

pub enum Response {
    
    /// `Standard` is a standard response.
    /// 
    /// ### Parameters
    /// 
    /// * `u16`: HTTP status code.
    /// * `&'static str`: Response message.
     
    Standard(u16, &'static str),

    /// `JsonData` is a response that contains data.
    /// 
    /// ### Parameters
    /// 
    /// * `u16`: HTTP status code.
    /// * `&'static str`: Response message.
    /// * `&'static str`: Name | key of the Value.
    /// * `Value`: The data of the response.
    /// 
    /// ### Example
    /// 
    /// ```rust
    /// use axum_responses::http::Response;
    /// use axum_responses::ToJson;
    /// 
    /// use serde::{Serialize, Deserialize};
    /// use serde_json::Value;
    /// 
    /// #[derive(Serialize, Deserialize)]
    /// struct TestStruct {
    ///    field: String
    /// }
    /// 
    /// impl ToJson for TestStruct {}
    /// 
    /// let test_struct = TestStruct {
    ///     field: "value".to_string()
    /// };
    /// 
    /// let response = Response::JsonData(
    ///     200, "Success", "data", test_struct.to_json()
    /// );
    /// ```

    JsonData(u16, &'static str, &'static str, Value)
}

impl IntoResponse for Response {

    fn into_response(self) -> HttpResponse {
        
        match self {

            Response::Standard(status, message) => {

                let code = to_http_status(status);
                
                let data = json!({ 
                    "status": code.as_u16(), "message": message 
                });

                return (code, Json(data)).into_response()
            },

            Response::JsonData(status, message, data_name, data) => {

                let code = to_http_status(status);
                
                let data = json!({
                    "status": code.as_u16(), 
                    "message": message, data_name: data
                });

                return (code, Json(data)).into_response()
            }
        }
    }
}