address 0.17.0-rc.1

This library aids in processing network addresses.
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

use crate::{IPv4Address, IPv6Address};

/// Either an IPv4 address or an IPv6 address.
#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
pub enum IPAddress {
    /// An IPv4 address.
    V4(IPv4Address),

    /// An IPv6 address.
    V6(IPv6Address),
}

impl From<IPv4Address> for IPAddress {
    fn from(v4: IPv4Address) -> Self {
        IPAddress::V4(v4)
    }
}

impl From<[u8; 4]> for IPAddress {
    fn from(address: [u8; 4]) -> Self {
        Self::from(IPv4Address::from(address))
    }
}

impl From<(u8, u8, u8, u8)> for IPAddress {
    fn from(tuple: (u8, u8, u8, u8)) -> Self {
        Self::from(IPv4Address::from(tuple))
    }
}

impl From<u32> for IPAddress {
    fn from(value: u32) -> Self {
        Self::from(IPv4Address::from(value))
    }
}

impl From<IPv6Address> for IPAddress {
    fn from(v6: IPv6Address) -> Self {
        Self::V6(v6)
    }
}

impl From<[u8; 16]> for IPAddress {
    fn from(address: [u8; 16]) -> Self {
        Self::from(IPv6Address::from(address))
    }
}

impl From<[u16; 8]> for IPAddress {
    fn from(segments: [u16; 8]) -> Self {
        Self::from(IPv6Address::from(segments))
    }
}

impl From<u128> for IPAddress {
    fn from(value: u128) -> Self {
        Self::from(IPv6Address::from(value))
    }
}

impl IPAddress {
    //! Matching

    /// Checks if the address is an IPv4 address.
    pub const fn is_v4(&self) -> bool {
        matches!(self, Self::V4(_))
    }

    /// Checks if the address is an IPv6 address.
    pub const fn is_v6(&self) -> bool {
        matches!(self, Self::V6(_))
    }
}

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

    #[test]
    fn construction() {
        let expected: IPAddress = IPAddress::V4(IPv4Address::LOCALHOST);
        let ip: IPAddress = IPv4Address::LOCALHOST.into();
        assert_eq!(ip, expected);
        let ip: IPAddress = [127, 0, 0, 1].into();
        assert_eq!(ip, expected);
        let ip: IPAddress = (127, 0, 0, 1).into();
        assert_eq!(ip, expected);
        let ip: IPAddress = 0x7F000001u32.into();
        assert_eq!(ip, expected);

        let expected: IPAddress = IPAddress::V6(IPv6Address::LOCALHOST);
        let ip: IPAddress = IPv6Address::LOCALHOST.into();
        assert_eq!(ip, expected);
        let ip: IPAddress = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1].into();
        assert_eq!(ip, expected);
        let ip: IPAddress = [0, 0, 0, 0, 0, 0, 0, 1].into();
        assert_eq!(ip, expected);
        let ip: IPAddress = 1u128.into();
        assert_eq!(ip, expected);
    }

    #[test]
    fn matching() {
        let ip: IPAddress = IPAddress::V4(IPv4Address::LOCALHOST);
        assert!(ip.is_v4());
        assert!(!ip.is_v6());

        let ip: IPAddress = IPAddress::V6(IPv6Address::LOCALHOST);
        assert!(!ip.is_v4());
        assert!(ip.is_v6());
    }
}