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

use crate::ParseError::{InvalidAuthority, InvalidHost};
use crate::{IPAddress, IPv4Address, IPv6Address, ParseError};

/// The host form of an authority.
#[must_use]
#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
pub(crate) enum HostForm {
    /// An IP address host, bracketed or not.
    IP(IPAddress),

    /// A domain name host. The domain must still be validated.
    Domain,
}

impl HostForm {
    //! Classification

    /// Classifies the authority `host`.
    pub(crate) fn classify(host: &[u8]) -> Result<Self, ParseError> {
        if host.starts_with(b"[") {
            Ok(Self::IP(IPv6Address::parse_bracketed(host)?.to_ip()))
        } else if let Ok(ip) = IPv4Address::parse(host) {
            Ok(Self::IP(ip.to_ip()))
        } else {
            Ok(Self::Domain)
        }
    }

    /// Gets the error for an invalid domain `host`.
    pub(crate) fn domain_error(host: &[u8]) -> ParseError {
        if host.contains(&b':') {
            InvalidAuthority
        } else {
            InvalidHost
        }
    }
}

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

    #[test]
    fn classify() {
        let test_cases: &[(&str, Result<HostForm, ParseError>)] = &[
            ("[::1]", Ok(HostForm::IP(IPv6Address::LOCALHOST.to_ip()))),
            ("[::1%1]", Ok(HostForm::IP(IPv6Address::LOCALHOST.to_ip()))),
            ("[::1%eth0]", Err(InvalidIPv6Address)),
            ("[]", Err(InvalidIPv6Address)),
            ("[127.0.0.1]", Err(InvalidIPv6Address)),
            ("[::1", Err(InvalidIPv6Address)),
            (
                "127.0.0.1",
                Ok(HostForm::IP(IPv4Address::LOCALHOST.to_ip())),
            ),
            ("::1", Ok(HostForm::Domain)),
            ("localhost", Ok(HostForm::Domain)),
        ];

        for (input, expected) in test_cases {
            let result: Result<HostForm, ParseError> = HostForm::classify(input.as_bytes());
            assert_eq!(result, *expected, "input={}", input);
        }
    }

    #[test]
    fn domain_error() {
        let test_cases: &[(&str, ParseError)] = &[
            ("::1", InvalidAuthority),
            ("fe80::1", InvalidAuthority),
            ("2001:db8::1", InvalidAuthority),
            ("a:b", InvalidAuthority),
            (":", InvalidAuthority),
            ("", InvalidHost),
            ("Local!Host", InvalidHost),
        ];

        for (input, expected) in test_cases {
            let result: ParseError = HostForm::domain_error(input.as_bytes());
            assert_eq!(result, *expected, "input={}", input);
        }
    }

    #[test]
    fn classify_does_not_validate_domains() {
        let test_cases: &[&str] = &["", "Local!Host", "a..b", "-a"];

        for input in test_cases {
            let result: Result<HostForm, ParseError> = HostForm::classify(input.as_bytes());
            assert_eq!(result, Ok(HostForm::Domain), "input={}", input);
        }
    }
}