api_response/error_code/
macros.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
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
146
147
148
149
use std::fmt::Display;

// re-export
pub use inventory;

use super::CodeSegment;
use crate::error_code::ApiErr;

/// Quickly create an `ApiError` builder `ApiErr` and collect error code mode information.
#[macro_export]
macro_rules! api_err {
    ($intro:expr) => {{
        $crate::error_code::inventory::submit! {
            $crate::error_code::ErrorCodeMode::new($intro, ::core::option::Option::None, ::core::option::Option::None, ::core::option::Option::None)
        }
        $crate::error_code::ApiErr::new0().intro($intro)
    }};
    ($s1:expr, $intro:expr) => {{
        $crate::error_code::inventory::submit! {
            $crate::error_code::ErrorCodeMode::new($intro, ::core::option::Option::Some($s1), ::core::option::Option::None, ::core::option::Option::None)
        }
        $crate::error_code::ApiErr::new1($s1).intro($intro)
    }};
    ($s1:expr, $s2:expr, $intro:expr) => {{
        $crate::error_code::inventory::submit! {
            $crate::error_code::ErrorCodeMode::new($intro, ::core::option::Option::Some($s1), ::core::option::Option::Some($s2), ::core::option::Option::None)
        }
        $crate::error_code::ApiErr::new2($s1,$s2).intro($intro)
    }};
    ($s1:expr, $s2:expr, $s3:expr, $intro:expr) => {{
        $crate::error_code::inventory::submit! {
            $crate::error_code::ErrorCodeMode::new($intro, ::core::option::Option::Some($s1), ::core::option::Option::Some($s2), ::core::option::Option::Some($s3))
        }
        $crate::error_code::ApiErr::new3($s1,$s2,$s3).intro($intro)
    }};
}

/// Quickly create an `ApiError` builder `ApiErrX` and collect error code mode information.
#[macro_export]
macro_rules! api_err_x {
    ($intro:expr) => {{
        $crate::error_code::inventory::submit! {
            $crate::error_code::ErrorCodeMode::new($intro, ::core::option::Option::None, ::core::option::Option::None, ::core::option::Option::None)
        }
        $crate::error_code::ApiErrX::new1().intro($intro)
    }};
    ($s1:expr, $intro:expr) => {{
        $crate::error_code::inventory::submit! {
            $crate::error_code::ErrorCodeMode::new($intro, ::core::option::Option::Some($s1), ::core::option::Option::None, ::core::option::Option::None)
        }
        $crate::error_code::ApiErrX::new2($s1).intro($intro)
    }};
    ($s1:expr, $s2:expr, $intro:expr) => {{
        $crate::error_code::inventory::submit! {
            $crate::error_code::ErrorCodeMode::new($intro, ::core::option::Option::Some($s1), ::core::option::Option::Some($s2), ::core::option::Option::None)
        }
        $crate::error_code::ApiErrX::new3($s1,$s2).intro($intro)
    }};
}

/// Obtain the list of error code modes.
pub fn error_code_modes() -> Vec<&'static ErrorCodeMode> {
    error_code_mode_iter().collect()
}

/// Obtain the iterator of error code modes.
pub fn error_code_mode_iter() -> impl Iterator<Item = &'static ErrorCodeMode> {
    inventory::iter::<ErrorCodeMode>.into_iter()
}

inventory::collect!(ErrorCodeMode);

#[derive(Debug)]
pub struct ErrorCodeMode {
    pub intro: &'static str,
    pub segment1: Option<CodeSegment>,
    pub segment2: Option<CodeSegment>,
    pub segment3: Option<CodeSegment>,
}

impl ErrorCodeMode {
    pub const fn new(
        intro: &'static str,
        segment1: Option<CodeSegment>,
        segment2: Option<CodeSegment>,
        segment3: Option<CodeSegment>,
    ) -> Self {
        Self {
            intro,
            segment1,
            segment2,
            segment3,
        }
    }
}

impl Display for ErrorCodeMode {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        Display::fmt(
            &ApiErr {
                intro: self.intro,
                s1: self.segment1,
                s2: self.segment2,
                s3: self.segment3,
            },
            f,
        )
    }
}

#[cfg(test)]
mod tests {
    use crate::error_code::*;

    #[test]
    fn macro_api_err() {
        const C1: ApiErr = api_err!("macro_api_err");
        assert_eq!("[??******]: macro_api_err", C1.to_string());

        const C2: ApiErr = api_err!(S01, "macro_api_err");
        assert_eq!("[??01****]: macro_api_err", C2.to_string());

        const C3: ApiErr = api_err!(S01, S22, "macro_api_err");
        assert_eq!("[??0122**]: macro_api_err", C3.to_string());

        const C4: ApiErr = api_err!(S01, S22, S33, "macro_api_err");
        assert_eq!("[??012233]: macro_api_err", C4.to_string());

        const X1: ApiErrX = api_err_x!("macro_api_err");
        assert_eq!("[??******]: macro_api_err", X1.to_string());

        const X2: ApiErrX = api_err_x!(S01, "macro_api_err");
        assert_eq!("[??01****]: macro_api_err", X2.to_string());

        const X3: ApiErrX = api_err_x!(S01, S22, "macro_api_err");
        assert_eq!("[??0122**]: macro_api_err", X3.to_string());

        let s = format!("{:?}", error_code_modes());
        println!("{s}");
        assert_eq!(
            r##"[ErrorCodeMode { intro: "macro_api_err", segment1: Some(S01), segment2: Some(S22), segment3: None }, ErrorCodeMode { intro: "macro_api_err", segment1: Some(S01), segment2: None, segment3: None }, ErrorCodeMode { intro: "macro_api_err", segment1: None, segment2: None, segment3: None }, ErrorCodeMode { intro: "macro_api_err", segment1: Some(S01), segment2: Some(S22), segment3: Some(S33) }, ErrorCodeMode { intro: "macro_api_err", segment1: Some(S01), segment2: Some(S22), segment3: None }, ErrorCodeMode { intro: "macro_api_err", segment1: Some(S01), segment2: None, segment3: None }, ErrorCodeMode { intro: "macro_api_err", segment1: None, segment2: None, segment3: None }]"##,
            s
        );

        for error_code_mode in error_code_mode_iter() {
            println!("{error_code_mode}");
        }
    }
}