address 0.23.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

use crate::IPAddress;

/// An [IPAddress] with an associated port.
#[must_use]
#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
pub struct SocketAddress {
    ip: IPAddress,
    port: u16,
}

impl SocketAddress {
    //! Construction

    /// Creates a new [SocketAddress].
    pub const fn new(ip: IPAddress, port: u16) -> Self {
        Self { ip, port }
    }
}

impl<A: Into<IPAddress>> From<(A, u16)> for SocketAddress {
    fn from(tuple: (A, u16)) -> Self {
        Self::new(tuple.0.into(), tuple.1)
    }
}

impl From<SocketAddress> for (IPAddress, u16) {
    fn from(socket: SocketAddress) -> Self {
        (socket.ip, socket.port)
    }
}

impl SocketAddress {
    //! Properties

    /// Gets the IP address.
    pub const fn ip(self) -> IPAddress {
        self.ip
    }

    /// Gets the port.
    #[must_use]
    pub const fn port(self) -> u16 {
        self.port
    }
}

impl SocketAddress {
    //! Matching

    /// Checks if the socket address is an IPv4 socket address.
    #[must_use]
    pub const fn is_v4(self) -> bool {
        self.ip.is_v4()
    }

    /// Checks if the socket address is an IPv6 socket address.
    #[must_use]
    pub const fn is_v6(self) -> bool {
        self.ip.is_v6()
    }
}

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

    #[test]
    fn construction() {
        let socket: SocketAddress = SocketAddress::new(IPAddress::V4(IPv4Address::LOCALHOST), 80);
        assert_eq!(socket.ip, IPAddress::V4(IPv4Address::LOCALHOST));
        assert_eq!(socket.port, 80);

        let socket: SocketAddress = (IPv4Address::LOCALHOST, 80).into();
        assert_eq!(socket.ip, IPAddress::V4(IPv4Address::LOCALHOST));
        assert_eq!(socket.port, 80);
    }

    #[test]
    fn deconstruction() {
        let socket: SocketAddress = (IPv4Address::LOCALHOST, 80).into();
        let (ip, port): (IPAddress, u16) = socket.into();
        assert_eq!(ip, IPAddress::V4(IPv4Address::LOCALHOST));
        assert_eq!(port, 80);
    }

    #[test]
    fn properties() {
        let socket: SocketAddress = (IPv4Address::LOCALHOST, 80).into();
        assert_eq!(socket.ip(), IPAddress::V4(IPv4Address::LOCALHOST));
        assert_eq!(socket.port(), 80);
    }

    #[test]
    fn matching() {
        let socket: SocketAddress = (IPv4Address::LOCALHOST, 80).into();
        assert!(socket.is_v4());
        assert!(!socket.is_v6());

        let socket: SocketAddress = (IPv6Address::LOCALHOST, 80).into();
        assert!(!socket.is_v4());
        assert!(socket.is_v6());
    }
}