rs-zero 0.2.7

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
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use axum::{Json, http::StatusCode, response::IntoResponse};
use serde::Serialize;

/// Uniform API response used by rs-zero REST services.
#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
pub struct ApiResponse<T>
where
    T: Serialize,
{
    pub success: bool,
    pub err_code: String,
    pub err_message: String,
    pub data: Option<T>,
}

impl<T> ApiResponse<T>
where
    T: Serialize,
{
    /// Creates a successful response.
    pub fn success(data: T) -> Self {
        Self {
            success: true,
            err_code: "0".to_string(),
            err_message: String::new(),
            data: Some(data),
        }
    }

    /// Creates a successful response without data.
    pub fn success_no_data() -> Self {
        Self {
            success: true,
            err_code: "0".to_string(),
            err_message: String::new(),
            data: None,
        }
    }

    /// Creates a failed response.
    pub fn fail(code: impl Into<String>, message: impl Into<String>) -> Self {
        Self {
            success: false,
            err_code: code.into(),
            err_message: message.into(),
            data: None,
        }
    }
}

impl<T> IntoResponse for ApiResponse<T>
where
    T: Serialize,
{
    fn into_response(self) -> axum::response::Response {
        (StatusCode::OK, Json(self)).into_response()
    }
}

/// Uniform paginated response.
#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
pub struct PageResponse<T>
where
    T: Serialize,
{
    pub success: bool,
    pub err_code: String,
    pub err_message: String,
    pub data: Vec<T>,
    pub total: i64,
    pub page_size: i64,
    pub has_more: bool,
    pub current_page: i64,
    pub total_pages: i64,
}

impl<T> PageResponse<T>
where
    T: Serialize,
{
    /// Creates a successful paginated response.
    pub fn success(data: Vec<T>, total: i64, page_size: i64, current_page: i64) -> Self {
        Self {
            success: true,
            err_code: "0".to_string(),
            err_message: String::new(),
            data,
            total,
            page_size,
            has_more: total > page_size * current_page,
            current_page,
            total_pages: if page_size <= 0 {
                0
            } else {
                (total + page_size - 1) / page_size
            },
        }
    }

    /// Creates an empty successful page.
    pub fn empty() -> Self {
        Self {
            success: true,
            err_code: "0".to_string(),
            err_message: String::new(),
            data: Vec::new(),
            total: 0,
            page_size: 0,
            has_more: false,
            current_page: 0,
            total_pages: 0,
        }
    }
}

impl<T> IntoResponse for PageResponse<T>
where
    T: Serialize,
{
    fn into_response(self) -> axum::response::Response {
        (StatusCode::OK, Json(self)).into_response()
    }
}

#[cfg(test)]
mod tests {
    use super::{ApiResponse, PageResponse};

    #[test]
    fn response_success_uses_zero_error_code() {
        let response = ApiResponse::success("ok");

        assert!(response.success);
        assert_eq!(response.err_code, "0");
        assert_eq!(response.data, Some("ok"));
    }

    #[test]
    fn page_response_calculates_total_pages() {
        let response = PageResponse::success(vec![1, 2], 11, 5, 2);

        assert!(response.has_more);
        assert_eq!(response.total_pages, 3);
    }
}