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

use crate::ParseError::InvalidHost;
use crate::{DomainRef, HostRef, IPAddress, ParseError, impl_parse_ref};

impl<'a> HostRef<'a> {
    //! Parse

    /// Parses a [HostRef] from the `text`.
    ///
    /// # Notes
    /// - IP addresses must be unbracketed: `::1`, not `[::1]`.
    /// - A domain must already be lowercase; use [`Host`](crate::Host) for normalization.
    pub fn parse(text: &'a [u8]) -> Result<Self, ParseError> {
        if let Ok(ip) = IPAddress::parse(text) {
            Ok(ip.to_host_ref())
        } else if let Ok(domain) = DomainRef::parse(text) {
            Ok(domain.to_host_ref())
        } else {
            Err(InvalidHost)
        }
    }
}

impl_parse_ref!(HostRef);

#[cfg(test)]
mod tests {
    use crate::ParseError::InvalidHost;
    use crate::{DomainRef, HostRef, IPv4Address, IPv6Address, ParseError};

    type TestCase<'a> = (&'a [u8], Result<HostRef<'a>, ParseError>);

    fn host(name: &'static str) -> HostRef<'static> {
        DomainRef::try_from(name).unwrap().to_host_ref()
    }

    #[test]
    fn parse() {
        let test_cases: &[TestCase] = &[
            (b"", Err(InvalidHost)),
            (b"localhost", Ok(host("localhost"))),
            (b"example.com", Ok(host("example.com"))),
            (b"LocalHost", Err(InvalidHost)),
            (b"www.example.com", Ok(host("www.example.com"))),
            (b"a-b.c--d.example", Ok(host("a-b.c--d.example"))),
            (b"127.0.0.1", Ok(IPv4Address::LOCALHOST.to_host_ref())),
            (b"::1", Ok(IPv6Address::LOCALHOST.to_host_ref())),
            (
                b"::FFFF",
                Ok(IPv6Address::from([0, 0, 0, 0, 0, 0, 0, 0xFFFF]).to_host_ref()),
            ),
            (b"[::1]", Err(InvalidHost)),
            (b"local_host", Err(InvalidHost)),
            (b"local!host", Err(InvalidHost)),
            (b"\xFF", Err(InvalidHost)),
            ("ΓΌ".as_bytes(), Err(InvalidHost)),
        ];

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

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

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

    #[test]
    fn round_trip() {
        let canonical: &[&str] = &[
            "localhost",
            "example.com",
            "a-b.c--d.example",
            "127.0.0.1",
            "::1",
            "fe80::1",
        ];

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