address 0.21.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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

use crate::ParseError::InvalidHost;
use crate::{
    Domain, Host, IPAddress, InvalidAddressError, ParseError, impl_parse, impl_parse_string,
};

impl Host {
    //! Parse

    /// Parses a [Host] from the `text`.
    pub fn parse(text: &[u8]) -> Result<Self, ParseError> {
        if let Ok(ip) = IPAddress::parse(text) {
            Ok(ip.to_host())
        } else if let Ok(domain) = Domain::parse(text) {
            Ok(domain.to_host())
        } else {
            Err(InvalidHost)
        }
    }

    /// Creates a host from the `text`, normalizing domain names to lowercase.
    ///
    /// The error holds the unmodified `text`, which `TryFrom<String>` soundly recovers as a string.
    pub(crate) fn parse_vec(text: Vec<u8>) -> Result<Self, InvalidAddressError<Vec<u8>>> {
        if let Ok(ip) = IPAddress::parse(text.as_slice()) {
            Ok(ip.to_host())
        } else {
            let len: usize = text.len();
            Domain::parse_vec_prefix(text, len)
                .map(Domain::to_host)
                .map_err(|text| InvalidAddressError::new(text, InvalidHost))
        }
    }
}

impl_parse!(
    Host,
    "IP addresses must be unbracketed: `::1`, not `[::1]`.",
    "Domain names are normalized to lowercase."
);

impl_parse_string!(
    Host,
    "IP addresses must be unbracketed: `::1`, not `[::1]`.",
    "Domain names are normalized to lowercase."
);

#[cfg(test)]
mod tests {
    use crate::ParseError::InvalidHost;
    use crate::{Domain, Host, IPv4Address, IPv6Address, InvalidAddressError, ParseError};
    use std::str::FromStr;

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

    fn host(name: &str) -> Host {
        Domain::try_from(name).unwrap().to_host()
    }

    #[test]
    fn parse() {
        let test_cases: &[TestCase] = &[
            (b"", Err(InvalidHost)),
            (b"localhost", Ok(host("localhost"))),
            (b"LocalHost", Ok(host("localhost"))),
            (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())),
            (b"::1", Ok(IPv6Address::LOCALHOST.to_host())),
            (
                b"::FFFF",
                Ok(IPv6Address::from([0, 0, 0, 0, 0, 0, 0, 0xFFFF]).to_host()),
            ),
            (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<Host, ParseError> = Host::parse(input);
            assert_eq!(result, *expected, "parse input={:?}", input);

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

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

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

            let result: Result<Host, InvalidAddressError<String>> =
                Host::try_from(text.to_string());
            let result: Result<Host, ParseError> = result.map_err(|error| {
                assert_eq!(error.value().as_str(), text, "recovered input={}", text);
                error.error()
            });
            assert_eq!(result, *expected, "try_from(String) 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: Host = input.parse().unwrap();
            assert_eq!(value.to_string(), *input, "input={}", input);
        }
    }
}