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

use crate::errors::ValidationError;
use crate::traits::ValueObject;
use std::net::Ipv6Addr;

/// Input type for [`IpV6Address`].
pub type IpV6AddressInput = String;

/// Output type for [`IpV6Address`].
pub type IpV6AddressOutput = String;

/// A validated IPv6 address (e.g. `"2001:db8::1"`).
///
/// **Normalisation:** trimmed; the address is stored in the canonical
/// compressed lowercase form produced by Rust's standard library
/// (e.g. `"2001:0db8:0000:0000:0000:0000:0000:0001"` → `"2001:db8::1"`).
///
/// # Example
///
/// ```rust,ignore
/// use arvo::net::IpV6Address;
/// use arvo::traits::ValueObject;
///
/// let ip = IpV6Address::new("2001:0db8::0001".into())?;
/// assert_eq!(ip.value(), "2001:db8::1");
///
/// let ip: IpV6Address = "::1".try_into()?;
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(transparent))]
pub struct IpV6Address(String);

impl ValueObject for IpV6Address {
    type Input = IpV6AddressInput;
    type Output = IpV6AddressOutput;
    type Error = ValidationError;

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

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

        trimmed
            .parse::<Ipv6Addr>()
            .map(|ip| Self(ip.to_string()))
            .map_err(|_| ValidationError::invalid("IpV6Address", trimmed))
    }

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

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

impl TryFrom<&str> for IpV6Address {
    type Error = ValidationError;

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

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

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

    #[test]
    fn accepts_loopback() {
        let ip = IpV6Address::new("::1".into()).unwrap();
        assert_eq!(ip.value(), "::1");
    }

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

    #[test]
    fn accepts_full_address() {
        assert!(IpV6Address::new("2001:db8:85a3::8a2e:370:7334".into()).is_ok());
    }

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

    #[test]
    fn rejects_ipv4() {
        assert!(IpV6Address::new("192.168.1.1".into()).is_err());
    }

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

    #[test]
    fn try_from_str() {
        let ip: IpV6Address = "::1".try_into().unwrap();
        assert_eq!(ip.value(), "::1");
    }
}