address 0.21.0

Network address types with strict validation, owned & borrowed variants, and standard library conversions.
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

use crate::{Host, HostRef, IPAddress, IPv4Address, IPv6Address, SocketAddressV6};

impl IPv6Address {
    //! Conversions

    /// Converts an IPv4 compatible (::a.b.c.d) or IPv4 mapped (::ffff:a.b.c.d) address to an IPv4
    /// address.
    ///
    /// Plain IPv6 addresses match the compatible pattern (`::1` -> `Ok(0.0.0.1)`); use
    /// [`Self::to_v4_mapped`] to avoid these false positives.
    pub const fn to_v4(self) -> Result<IPv4Address, Self> {
        match self.address() {
            [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, a, b, c, d] => Ok(IPv4Address::new([a, b, c, d])),
            [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF, a, b, c, d] => {
                Ok(IPv4Address::new([a, b, c, d]))
            }
            _ => Err(self),
        }
    }

    /// Converts an IPv4 mapped (::ffff:a.b.c.d) address to an IPv4 address.
    ///
    /// Unlike [`Self::to_v4`], IPv4 compatible addresses (::a.b.c.d) are an error.
    pub const fn to_v4_mapped(self) -> Result<IPv4Address, Self> {
        match self.address() {
            [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF, a, b, c, d] => {
                Ok(IPv4Address::new([a, b, c, d]))
            }
            _ => Err(self),
        }
    }

    /// Converts the address to an IP address.
    pub const fn to_ip(self) -> IPAddress {
        IPAddress::V6(self)
    }

    /// Converts the address to a socket address with the `port`.
    pub const fn to_socket(self, port: u16) -> SocketAddressV6 {
        SocketAddressV6::new(self, port)
    }

    /// Converts the address to a host.
    pub const fn to_host(self) -> Host {
        Host::IPAddress(self.to_ip())
    }

    /// Converts the address to a host reference.
    pub const fn to_host_ref(self) -> HostRef<'static> {
        HostRef::IPAddress(self.to_ip())
    }
}

impl TryFrom<IPAddress> for IPv6Address {
    type Error = IPAddress;

    fn try_from(ip: IPAddress) -> Result<Self, Self::Error> {
        ip.to_v6()
    }
}

#[cfg(test)]
mod tests {
    use crate::{Host, HostRef, IPAddress, IPv4Address, IPv6Address, SocketAddressV6};

    #[test]
    fn v6_to_v4() {
        let test_cases: &[(IPv6Address, Result<IPv4Address, IPv6Address>)] = &[
            (
                IPv6Address::from([0, 0, 0, 0, 0, 0, 0x7F00, 1]),
                Ok(IPv4Address::LOCALHOST),
            ),
            (
                IPv6Address::from([0, 0, 0, 0, 0, 0xFFFF, 0x7F00, 1]),
                Ok(IPv4Address::LOCALHOST),
            ),
            (
                IPv6Address::from([1, 0, 0, 0, 0, 0, 0, 0]),
                Err(IPv6Address::from([1, 0, 0, 0, 0, 0, 0, 0])),
            ),
            (
                IPv6Address::from([0, 0, 0, 0, 0, 1, 0, 0]),
                Err(IPv6Address::from([0, 0, 0, 0, 0, 1, 0, 0])),
            ),
        ];

        for (ip, expected) in test_cases {
            let result: Result<IPv4Address, IPv6Address> = ip.to_v4();
            assert_eq!(result, *expected, "ip={}", ip);
        }

        let ip: IPv6Address = IPv6Address::from([0, 0, 0, 0, 0, 0xFFFF, 0x7F00, 1]);
        let result: Result<IPv4Address, IPv6Address> = ip.to_v4_mapped();
        let expected: Result<IPv4Address, IPv6Address> = Ok(IPv4Address::LOCALHOST);
        assert_eq!(result, expected);

        let ip: IPv6Address = IPv6Address::from([0, 0, 0, 0, 0, 0, 0x7F00, 1]);
        let result: Result<IPv4Address, IPv6Address> = ip.to_v4_mapped();
        let expected: Result<IPv4Address, IPv6Address> = Err(ip);
        assert_eq!(result, expected);
    }

    #[test]
    fn v6_to_ip() {
        let ip: IPv6Address = IPv6Address::LOCALHOST;
        let result: IPAddress = ip.to_ip();
        let expected: IPAddress = IPAddress::V6(IPv6Address::LOCALHOST);
        assert_eq!(result, expected);
    }

    #[test]
    fn v6_to_socket() {
        let ip: IPv6Address = IPv6Address::LOCALHOST;
        let result: SocketAddressV6 = ip.to_socket(80);
        let expected: SocketAddressV6 = SocketAddressV6::new(IPv6Address::LOCALHOST, 80);
        assert_eq!(result, expected);
    }

    #[test]
    fn v6_to_host() {
        let ip: IPv6Address = IPv6Address::LOCALHOST;

        let result: Host = ip.to_host();
        let expected: Host = Host::IPAddress(IPAddress::V6(IPv6Address::LOCALHOST));
        assert_eq!(result, expected);

        let result: HostRef = ip.to_host_ref();
        let expected: HostRef = HostRef::IPAddress(IPAddress::V6(IPv6Address::LOCALHOST));
        assert_eq!(result, expected);
    }

    #[test]
    fn v6_try_from() {
        let ip: IPAddress = IPv6Address::LOCALHOST.to_ip();
        assert_eq!(IPv6Address::try_from(ip), Ok(IPv6Address::LOCALHOST));

        let ip: IPAddress = IPv4Address::LOCALHOST.to_ip();
        assert_eq!(IPv6Address::try_from(ip), Err(ip));
    }
}