address 0.19.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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

/// An IPv4 address. (a.b.c.d)
#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug, Default)]
pub struct IPv4Address {
    address: [u8; 4],
}

impl IPv4Address {
    //! Special Addresses

    /// The unspecified address. (0.0.0.0)
    pub const UNSPECIFIED: Self = Self::new([0, 0, 0, 0]);

    /// The localhost address. (127.0.0.1)
    pub const LOCALHOST: Self = Self::new([127, 0, 0, 1]);

    /// The broadcast address. (255.255.255.255)
    pub const BROADCAST: Self = Self::new([255, 255, 255, 255]);
}

impl IPv4Address {
    //! Construction

    /// Creates a new IPv4 address. [a, b, c, d]
    pub const fn new(address: [u8; 4]) -> Self {
        Self { address }
    }
}

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

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

impl From<(u8, u8, u8, u8)> for IPv4Address {
    fn from(tuple: (u8, u8, u8, u8)) -> Self {
        Self::new([tuple.0, tuple.1, tuple.2, tuple.3])
    }
}

impl From<IPv4Address> for (u8, u8, u8, u8) {
    fn from(ip: IPv4Address) -> Self {
        ip.bytes()
    }
}

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

impl From<IPv4Address> for u32 {
    fn from(ip: IPv4Address) -> Self {
        u32::from_be_bytes(ip.address)
    }
}

impl IPv4Address {
    //! Properties

    /// Gets the address. [a, b, c, d]
    pub const fn address(self) -> [u8; 4] {
        self.address
    }

    /// Gets the bytes. (a, b, c, d)
    pub const fn bytes(self) -> (u8, u8, u8, u8) {
        (
            self.address[0],
            self.address[1],
            self.address[2],
            self.address[3],
        )
    }
}

#[cfg(test)]
mod tests {
    use crate::IPv4Address;

    #[test]
    fn default() {
        assert_eq!(IPv4Address::default(), IPv4Address::UNSPECIFIED);
    }

    #[test]
    fn specials() {
        assert_eq!(IPv4Address::UNSPECIFIED.address, [0, 0, 0, 0]);
        assert_eq!(IPv4Address::LOCALHOST.address, [127, 0, 0, 1]);
        assert_eq!(IPv4Address::BROADCAST.address, [255, 255, 255, 255]);
    }

    #[test]
    fn construction() {
        let address: [u8; 4] = [0x12, 0x34, 0x56, 0x78];
        let bytes: (u8, u8, u8, u8) = (0x12, 0x34, 0x56, 0x78);
        let value: u32 = 0x12345678u32;

        let ip: IPv4Address = IPv4Address::new(address);
        assert_eq!(ip.address, address);

        assert_eq!(ip, IPv4Address::from(address));
        assert_eq!(ip, IPv4Address::from(bytes));
        assert_eq!(ip, IPv4Address::from(value));

        let result: [u8; 4] = ip.into();
        assert_eq!(result, address);
        let result: (u8, u8, u8, u8) = ip.into();
        assert_eq!(result, bytes);
        let result: u32 = ip.into();
        assert_eq!(result, value);
    }

    #[test]
    fn properties() {
        let ip: IPv4Address = IPv4Address::LOCALHOST;
        assert_eq!(ip.address(), [127, 0, 0, 1]);
        assert_eq!(ip.bytes(), (127, 0, 0, 1));
    }
}