address 0.19.0-rc.2

This library aids in processing network addresses.
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

use crate::ParseError::InvalidDomain;
use crate::{Domain, ParseError};

/// A domain name reference.
///
/// See `Domain` for the domain name validation rules. A borrowed name cannot be normalized, so
/// the name must already be lowercase.
#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
pub struct DomainRef<'a> {
    name: &'a str,
}

impl<'a> DomainRef<'a> {
    //! Special Domains

    /// The `localhost` domain reference.
    pub const LOCALHOST: Self = Self { name: "localhost" };

    /// The `example.com` domain reference.
    pub const EXAMPLE: Self = Self {
        name: "example.com",
    };
}

impl<'a> DomainRef<'a> {
    //! Construction

    /// Creates a new domain reference.
    ///
    /// # Safety
    /// The `name` must be valid and lowercase. Validity is a struct invariant that unsafe code
    /// may rely on.
    pub unsafe fn new_unchecked(name: &'a str) -> Self {
        debug_assert!(Domain::is_valid_name_str(name, false));

        Self { name }
    }
}

impl<'a> TryFrom<&'a str> for DomainRef<'a> {
    type Error = ParseError;

    /// The `name` must already be lowercase, since a borrowed name cannot be normalized. Use
    /// `Domain::try_from` to parse mixed-case names.
    fn try_from(name: &'a str) -> Result<Self, Self::Error> {
        if Domain::is_valid_name_str(name, false) {
            Ok(Self { name })
        } else {
            Err(InvalidDomain)
        }
    }
}

impl<'a> TryFrom<&'a [u8]> for DomainRef<'a> {
    type Error = ParseError;

    /// The `name` must already be lowercase, since a borrowed name cannot be normalized. Use
    /// `Domain::try_from` to parse mixed-case names.
    fn try_from(name: &'a [u8]) -> Result<Self, Self::Error> {
        if Domain::is_valid_name(name, false) {
            let name: &str = unsafe { std::str::from_utf8_unchecked(name) };
            Ok(Self { name })
        } else {
            Err(InvalidDomain)
        }
    }
}

impl<'a> DomainRef<'a> {
    //! Properties

    /// Gets the name.
    pub const fn name(self) -> &'a str {
        self.name
    }
}

#[cfg(test)]
mod tests {
    use crate::ParseError::InvalidDomain;
    use crate::{DomainRef, ParseError};

    #[test]
    fn specials() {
        assert_eq!(DomainRef::LOCALHOST.name, "localhost");
        assert_eq!(DomainRef::EXAMPLE.name, "example.com");
    }

    #[test]
    fn try_from_str() {
        let result: Result<DomainRef, ParseError> = DomainRef::try_from("localhost");
        assert_eq!(result, Ok(DomainRef::LOCALHOST));

        let result: Result<DomainRef, ParseError> = DomainRef::try_from("LocalHost");
        assert_eq!(result, Err(InvalidDomain));
    }

    #[test]
    fn try_from_slice() {
        let result: Result<DomainRef, ParseError> = DomainRef::try_from("localhost".as_bytes());
        assert_eq!(result, Ok(DomainRef::LOCALHOST));

        let result: Result<DomainRef, ParseError> = DomainRef::try_from("LocalHost".as_bytes());
        assert_eq!(result, Err(InvalidDomain));
    }

    #[test]
    fn properties() {
        let domain: DomainRef = DomainRef::LOCALHOST;
        assert_eq!(domain.name(), "localhost");
    }
}