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

use crate::ParseError::InvalidIPAddress;
use crate::{IPAddress, ParseError, impl_parse};
use std::net::IpAddr;
use std::str::FromStr;

impl IPAddress {
    //! Parse

    /// Parses an [IPAddress] from the `text`.
    ///
    /// # Notes
    /// - The embedded IPv4 form is accepted. (`::ffff:1.2.3.4`)
    /// - Brackets & zones are not accepted; see [`SocketAddress`](crate::SocketAddress).
    pub fn parse(text: &[u8]) -> Result<Self, ParseError> {
        const MAX_STR_LEN: usize = "ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255".len();
        if text.len() > MAX_STR_LEN {
            return Err(InvalidIPAddress);
        }
        let text: &str = std::str::from_utf8(text).map_err(|_| InvalidIPAddress)?;
        Ok(IpAddr::from_str(text).map_err(|_| InvalidIPAddress)?.into())
    }
}

impl_parse!(IPAddress);

#[cfg(test)]
mod tests {
    use crate::ParseError::InvalidIPAddress;
    use crate::{IPAddress, IPv4Address, IPv6Address, ParseError};
    use std::str::FromStr;

    type TestCase<'a> = (&'a [u8], Result<IPAddress, ParseError>);
    const MAX_STR_LEN: usize = "ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255".len();

    #[test]
    fn parse() {
        let over_max: Vec<u8> = vec![b'0'; MAX_STR_LEN + 1];
        let test_cases: &[TestCase] = &[
            (b"", Err(InvalidIPAddress)),
            (b"127.0.0.1", Ok(IPv4Address::LOCALHOST.to_ip())),
            (b"::1", Ok(IPv6Address::LOCALHOST.to_ip())),
            (
                b"::ffff:1.2.3.4",
                Ok(IPv6Address::from([0, 0, 0, 0, 0, 0xFFFF, 0x0102, 0x0304]).to_ip()),
            ),
            (b"[::1]", Err(InvalidIPAddress)),
            (b"fe80::1%1", Err(InvalidIPAddress)),
            (b"localhost", Err(InvalidIPAddress)),
            (b"\xFF", Err(InvalidIPAddress)),
            (over_max.as_slice(), Err(InvalidIPAddress)),
        ];

        for (input, expected) in test_cases {
            let result: Result<IPAddress, ParseError> = IPAddress::parse(input);
            assert_eq!(result, *expected, "parse input={:?}", input);

            let Ok(text) = std::str::from_utf8(input) else {
                continue;
            };

            let result: Result<IPAddress, ParseError> = IPAddress::from_str(text);
            assert_eq!(result, *expected, "from_str input={}", text);

            let result: Result<IPAddress, ParseError> = IPAddress::try_from(text);
            assert_eq!(result, *expected, "try_from(&str) input={}", text);
        }
    }

    #[test]
    fn round_trip() {
        let canonical: &[&str] = &[
            "127.0.0.1",
            "255.255.255.255",
            "::1",
            "fe80::1",
            "::ffff:1.2.3.4",
        ];

        for input in canonical {
            let value: IPAddress = input.parse().unwrap();
            assert_eq!(value.to_string(), *input, "input={}", input);
        }
    }
}