api_response/
success.rs

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
use serde::{Deserialize, Serialize};

use crate::ApiResponse;

/// Struct to represent a successful response
#[cfg_attr(feature = "salvo", derive(salvo::prelude::ToSchema))]
#[derive(Debug, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SuccessResponse<Data, Meta> {
    pub data: Data,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub meta: Option<Meta>,
}

impl<Data, Meta> SuccessResponse<Data, Meta> {
    #[inline(always)]
    pub const fn new(data: Data, meta: Meta) -> Self {
        SuccessResponse { data, meta: Some(meta) }
    }
    #[inline(always)]
    pub const fn from_data(data: Data) -> Self {
        SuccessResponse { data, meta: None }
    }
    #[inline(always)]
    pub fn with_meta(mut self, meta: Meta) -> Self {
        self.set_meta(meta);
        self
    }
    #[inline(always)]
    pub fn set_meta(&mut self, meta: Meta) -> &mut Self {
        self.meta = Some(meta);
        self
    }
}

pub trait ApiSuccessResponse: Sized {
    fn api_response<Meta>(self, meta: Option<Meta>) -> ApiResponse<Self, Meta> {
        ApiResponse::Success(SuccessResponse { data: self, meta })
    }
    #[inline(always)]
    fn api_response_without_meta<Meta>(self) -> ApiResponse<Self, Meta> {
        self.api_response(None)
    }
    #[inline(always)]
    fn api_response_with_meta<Meta>(self, meta: Meta) -> ApiResponse<Self, Meta> {
        self.api_response(Some(meta))
    }
}

impl<Data> ApiSuccessResponse for Data {}