routerify-json-response 3.0.0

A Routerify utility library to generate JSON response.
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

use crate::gen_resp::gen_response;
use http::{Response, StatusCode};
use http_body::Body as HttpBody;
use serde::Serialize;

const STATUS_SUCCESS: &'static str = "success";

#[derive(Serialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
struct SuccessResp<'a, D>
where
    D: Serialize + Send + Sync + Unpin,
{
    status: &'static str,
    code: u16,
    data: &'a D,
}

/// Generates a success JSON response with the provided data and the status code.
///
/// It generates JSON response in the following JSON format:
///
///  ```json
///  {
///      "status": "success",
///      "code": "<status_code>",
///      "data": "<data>"
///  }
///```
///
/// # Examples
///
/// ```
/// use hyper::{Body, Request, Response, StatusCode};
/// use routerify_json_response::{json_success_resp_with_code};
///
/// async fn list_users_handler(_: Request<Body>) -> Result<Response<Body>, routerify_json_response::Error> {
///     // Fetch response data from somewhere.
///     let users = ["Alice", "John"];
///
///     // Generate a success JSON response with the data in the following format:
///     // { "status": "success", code: 201, data: ["Alice", "John"] }
///     json_success_resp_with_code(StatusCode::CREATED, &users)
/// }
/// ```
pub fn json_success_resp_with_code<B, D>(code: StatusCode, data: &D) -> crate::Result<Response<B>>
where
    B: HttpBody + From<Vec<u8>> + Send + Sync + Unpin + 'static,
    D: Serialize + Send + Sync + Unpin,
{
    let resp_data = SuccessResp {
        status: STATUS_SUCCESS,
        code: code.as_u16(),
        data,
    };

    gen_response(code, &resp_data)
}

/// Generates a success JSON response with the provided data and the `OK 200` status code.
///
/// It generates JSON response in the following JSON format:
///
///  ```json
///  {
///      "status": "success",
///      "code": "200",
///      "data": "<data>"
///  }
///```
///
/// # Examples
///
/// ```
/// use hyper::{Body, Request, Response, StatusCode};
/// use routerify_json_response::{json_success_resp};
///
/// async fn list_users_handler(_: Request<Body>) -> Result<Response<Body>, routerify_json_response::Error> {
///     // Fetch response data from somewhere.
///     let users = ["Alice", "John"];
///
///     // Generate a success JSON response with the data in the following format:
///     // { "status": "success", code: 200, data: ["Alice", "John"] }
///     json_success_resp(&users)
/// }
/// ```
pub fn json_success_resp<B, D>(data: &D) -> crate::Result<Response<B>>
where
    B: HttpBody + From<Vec<u8>> + Send + Sync + Unpin + 'static,
    D: Serialize + Send + Sync + Unpin,
{
    json_success_resp_with_code::<B, D>(StatusCode::OK, data)
}