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

use crate::ParseError::InvalidDomain;
use crate::parse_port;
use crate::{Domain, Endpoint, InvalidAddressError, ParseError, impl_parse, impl_parse_string};

impl Endpoint {
    //! Parse

    /// Parses an [Endpoint] from the `text`.
    ///
    /// # Notes
    /// - The domain name is normalized to lowercase.
    pub fn parse(text: &[u8]) -> Result<Self, ParseError> {
        let (name, port): (&[u8], u16) = parse_port(text)?;
        let domain: Domain = Domain::parse(name)?;
        Ok(domain.to_endpoint(port))
    }

    /// Parses an [Endpoint] from the `text`.
    pub(crate) fn parse_string(text: String) -> Result<Self, InvalidAddressError<String>> {
        match parse_port(text.as_bytes()) {
            Ok((name, port)) => {
                let name_len: usize = name.len();
                Domain::parse_string_prefix(text, name_len)
                    .map(|domain| domain.to_endpoint(port))
                    .map_err(|text| InvalidAddressError::new(text, InvalidDomain))
            }
            Err(error) => Err(InvalidAddressError::new(text, error)),
        }
    }
}

impl_parse!(Endpoint);

impl_parse_string!(Endpoint);

#[cfg(test)]
mod tests {
    use crate::ParseError::{InvalidDomain, InvalidPort};
    use crate::{Domain, Endpoint, InvalidAddressError, ParseError};
    use std::str::FromStr;

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

    fn endpoint(name: &str, port: u16) -> Endpoint {
        Domain::try_from(name).unwrap().to_endpoint(port)
    }

    #[test]
    fn parse() {
        let test_cases: &[TestCase] = &[
            (b"", Err(InvalidPort)),
            (b"localhost", Err(InvalidPort)),
            (b"localhost:", Err(InvalidPort)),
            (b"localhost:xx", Err(InvalidPort)),
            (b"localhost:99999", Err(InvalidPort)),
            (b"localhost:80", Ok(endpoint("localhost", 80))),
            (b"example.com:443", Ok(endpoint("example.com", 443))),
            (b"LocalHost:80", Ok(endpoint("localhost", 80))),
            (b"WWW.Example.COM:443", Ok(endpoint("www.example.com", 443))),
            (b":80", Err(InvalidDomain)),
            (b"[localhost]:80", Err(InvalidDomain)),
            (b"Local_Host:80", Err(InvalidDomain)),
            (b"Local!Host:80", Err(InvalidDomain)),
            (b"127.0.0.1:80", Err(InvalidDomain)),
            (b"\xFF:80", Err(InvalidDomain)),
            ("ΓΌ:80".as_bytes(), Err(InvalidDomain)),
        ];

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

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

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

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

            let result: Result<Endpoint, InvalidAddressError<String>> =
                Endpoint::try_from(text.to_string());
            let result: Result<Endpoint, 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:80", "example.com:443", "a.b.c:65535", "x:0"];

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