arvo 0.9.0

Validated, immutable value objects for common domain types (email, money, identifiers, …)
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

use crate::errors::ValidationError;
use crate::traits::ValueObject;

/// Input type for [`HttpStatusCode`].
pub type HttpStatusCodeInput = u16;

/// Output type for [`HttpStatusCode`].
pub type HttpStatusCodeOutput = u16;

/// A validated HTTP status code in the range `100..=599`.
///
/// # Example
///
/// ```rust,ignore
/// use arvo::net::HttpStatusCode;
/// use arvo::traits::ValueObject;
///
/// let code = HttpStatusCode::new(200)?;
/// assert_eq!(*code.value(), 200);
/// assert!(code.is_success());
///
/// assert!(HttpStatusCode::new(600).is_err());
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(transparent))]
pub struct HttpStatusCode(u16);

impl ValueObject for HttpStatusCode {
    type Input = HttpStatusCodeInput;
    type Output = HttpStatusCodeOutput;
    type Error = ValidationError;

    fn new(value: Self::Input) -> Result<Self, Self::Error> {
        if !(100..=599).contains(&value) {
            return Err(ValidationError::invalid(
                "HttpStatusCode",
                &value.to_string(),
            ));
        }
        Ok(Self(value))
    }

    fn value(&self) -> &Self::Output {
        &self.0
    }

    fn into_inner(self) -> Self::Input {
        self.0
    }
}

impl HttpStatusCode {
    /// Returns `true` for 1xx informational codes.
    pub fn is_informational(&self) -> bool {
        (100..=199).contains(&self.0)
    }

    /// Returns `true` for 2xx success codes.
    pub fn is_success(&self) -> bool {
        (200..=299).contains(&self.0)
    }

    /// Returns `true` for 3xx redirection codes.
    pub fn is_redirection(&self) -> bool {
        (300..=399).contains(&self.0)
    }

    /// Returns `true` for 4xx client error codes.
    pub fn is_client_error(&self) -> bool {
        (400..=499).contains(&self.0)
    }

    /// Returns `true` for 5xx server error codes.
    pub fn is_server_error(&self) -> bool {
        (500..=599).contains(&self.0)
    }
}

impl std::fmt::Display for HttpStatusCode {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

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

    #[test]
    fn accepts_200() {
        let code = HttpStatusCode::new(200).unwrap();
        assert_eq!(*code.value(), 200);
    }

    #[test]
    fn accepts_boundaries() {
        assert!(HttpStatusCode::new(100).is_ok());
        assert!(HttpStatusCode::new(599).is_ok());
    }

    #[test]
    fn rejects_below_100() {
        assert!(HttpStatusCode::new(99).is_err());
    }

    #[test]
    fn rejects_600_and_above() {
        assert!(HttpStatusCode::new(600).is_err());
    }

    #[test]
    fn category_helpers() {
        assert!(HttpStatusCode::new(100).unwrap().is_informational());
        assert!(HttpStatusCode::new(200).unwrap().is_success());
        assert!(HttpStatusCode::new(301).unwrap().is_redirection());
        assert!(HttpStatusCode::new(404).unwrap().is_client_error());
        assert!(HttpStatusCode::new(500).unwrap().is_server_error());
    }

    #[test]
    fn display() {
        let code = HttpStatusCode::new(404).unwrap();
        assert_eq!(code.to_string(), "404");
    }

    #[test]
    fn into_inner_roundtrip() {
        let code = HttpStatusCode::new(201).unwrap();
        assert_eq!(code.into_inner(), 201);
    }
}