arvo 1.0.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
133
134
135
136
137
138
139
140
141
142
143
144
145

use crate::errors::ValidationError;
use crate::traits::{PrimitiveValue, ValueObject};

use super::{IpV4Address, IpV6Address};

/// Input for [`IpAddress`] — either a v4 or v6 address string.
pub type IpAddressInput = String;

/// A validated IP address — either IPv4 or IPv6.
///
/// Tries IPv4 first, then IPv6. The canonical string is stored normalised.
///
/// # Example
///
/// ```rust,ignore
/// use arvo::net::IpAddress;
/// use arvo::traits::ValueObject;
///
/// let ip = IpAddress::new("192.168.1.1".into())?;
/// assert!(ip.is_v4());
///
/// let ip = IpAddress::new("::1".into())?;
/// assert!(ip.is_v6());
///
/// let ip: IpAddress = "10.0.0.1".try_into()?;
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(try_from = "String", into = "String"))]
pub struct IpAddress(String);

impl ValueObject for IpAddress {
    type Input = IpAddressInput;
    type Error = ValidationError;

    fn new(value: Self::Input) -> Result<Self, Self::Error> {
        let trimmed = value.trim();

        if trimmed.is_empty() {
            return Err(ValidationError::empty("IpAddress"));
        }

        if let Ok(v4) = IpV4Address::new(trimmed.to_owned()) {
            return Ok(Self(v4.into_inner()));
        }

        if let Ok(v6) = IpV6Address::new(trimmed.to_owned()) {
            return Ok(Self(v6.into_inner()));
        }

        Err(ValidationError::invalid("IpAddress", trimmed))
    }

    fn into_inner(self) -> Self::Input {
        self.0
    }
}
impl PrimitiveValue for IpAddress {
    type Primitive = String;
    fn value(&self) -> &String {
        &self.0
    }
}

impl IpAddress {
    /// Returns `true` if the address is IPv4.
    pub fn is_v4(&self) -> bool {
        self.0.contains('.')
    }

    /// Returns `true` if the address is IPv6.
    pub fn is_v6(&self) -> bool {
        self.0.contains(':')
    }
}

impl TryFrom<String> for IpAddress {
    type Error = ValidationError;
    fn try_from(s: String) -> Result<Self, Self::Error> {
        Self::new(s)
    }
}

#[cfg(feature = "serde")]
impl From<IpAddress> for String {
    fn from(v: IpAddress) -> String {
        v.0
    }
}
impl TryFrom<&str> for IpAddress {
    type Error = ValidationError;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        Self::new(value.to_owned())
    }
}

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

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

    #[test]
    fn accepts_ipv4() {
        let ip = IpAddress::new("192.168.1.1".into()).unwrap();
        assert_eq!(ip.value(), "192.168.1.1");
        assert!(ip.is_v4());
        assert!(!ip.is_v6());
    }

    #[test]
    fn accepts_ipv6() {
        let ip = IpAddress::new("::1".into()).unwrap();
        assert_eq!(ip.value(), "::1");
        assert!(ip.is_v6());
        assert!(!ip.is_v4());
    }

    #[test]
    fn normalises_ipv6() {
        let ip = IpAddress::new("2001:0db8::0001".into()).unwrap();
        assert_eq!(ip.value(), "2001:db8::1");
    }

    #[test]
    fn rejects_empty() {
        assert!(IpAddress::new(String::new()).is_err());
    }

    #[test]
    fn rejects_invalid() {
        assert!(IpAddress::new("not-an-ip".into()).is_err());
    }

    #[test]
    fn try_from_str() {
        let ip: IpAddress = "10.0.0.1".try_into().unwrap();
        assert!(ip.is_v4());
    }
}