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

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

/// Input type for [`Port`].
pub type PortInput = u16;

/// Output type for [`Port`].
pub type PortOutput = u16;

/// A validated network port number in the range `1..=65535`.
///
/// Port 0 is reserved and rejected.
///
/// # Example
///
/// ```rust,ignore
/// use arvo::net::Port;
/// use arvo::traits::ValueObject;
///
/// let port = Port::new(8080)?;
/// assert_eq!(*port.value(), 8080);
///
/// assert!(Port::new(0).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 Port(u16);

impl ValueObject for Port {
    type Input = PortInput;
    type Output = PortOutput;
    type Error = ValidationError;

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

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

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

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

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

    #[test]
    fn accepts_valid_port() {
        let port = Port::new(8080).unwrap();
        assert_eq!(*port.value(), 8080);
    }

    #[test]
    fn accepts_port_1() {
        assert!(Port::new(1).is_ok());
    }

    #[test]
    fn accepts_port_65535() {
        assert!(Port::new(65535).is_ok());
    }

    #[test]
    fn accepts_well_known_ports() {
        assert!(Port::new(80).is_ok());
        assert!(Port::new(443).is_ok());
        assert!(Port::new(22).is_ok());
    }

    #[test]
    fn rejects_zero() {
        assert!(Port::new(0).is_err());
    }

    #[test]
    fn display() {
        let port = Port::new(443).unwrap();
        assert_eq!(port.to_string(), "443");
    }

    #[test]
    fn into_inner_roundtrip() {
        let port = Port::new(3000).unwrap();
        assert_eq!(port.into_inner(), 3000);
    }
}