address 0.19.0-rc.2

This library aids in processing network addresses.
use crate::ParseError::InvalidDomain;
use crate::{DomainRef, InvalidDomainName, ParseError};

/// A domain name.
///
/// Domain names are lowercase ASCII letters, digits, and dashes: dot-separated labels that must
/// not start or end with a dash. (see `Domain::is_valid_name`) Mixed-case input is normalized to
/// lowercase when parsed.
#[derive(Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
pub struct Domain {
    name: String,
}

impl Domain {
    //! Special Domains

    /// Creates the `localhost` domain.
    pub fn localhost() -> Self {
        DomainRef::LOCALHOST.to_domain()
    }

    /// Creates the `example.com` domain.
    pub fn example() -> Self {
        DomainRef::EXAMPLE.to_domain()
    }
}

impl Domain {
    //! Construction

    /// Creates a new domain.
    ///
    /// # Safety
    /// The `name` must be valid and lowercase. Validity is a struct invariant that unsafe code
    /// may rely on.
    pub unsafe fn new_unchecked<S>(name: S) -> Self
    where
        S: Into<String>,
    {
        let name: String = name.into();

        debug_assert!(Self::is_valid_name_str(name.as_str(), false));

        Self { name }
    }
}

impl TryFrom<String> for Domain {
    type Error = InvalidDomainName<String>;

    fn try_from(name: String) -> Result<Self, Self::Error> {
        if Self::is_valid_name_str(name.as_str(), false) {
            Ok(Self { name })
        } else if Self::is_valid_name_str(name.as_str(), true) {
            let mut name: String = name;
            name.make_ascii_lowercase();
            Ok(Self { name })
        } else {
            Err(InvalidDomainName::new(name))
        }
    }
}

impl TryFrom<&str> for Domain {
    type Error = ParseError;

    fn try_from(name: &str) -> Result<Self, Self::Error> {
        if Self::is_valid_name_str(name, false) {
            let name: String = name.to_string();
            Ok(Self { name })
        } else if Self::is_valid_name_str(name, true) {
            let name: String = name.to_ascii_lowercase();
            Ok(Self { name })
        } else {
            Err(InvalidDomain)
        }
    }
}

impl TryFrom<Vec<u8>> for Domain {
    type Error = InvalidDomainName<Vec<u8>>;

    fn try_from(name: Vec<u8>) -> Result<Self, Self::Error> {
        if Self::is_valid_name(name.as_slice(), false) {
            let name: String = unsafe { String::from_utf8_unchecked(name) };
            Ok(Self { name })
        } else if Self::is_valid_name(name.as_slice(), true) {
            let mut name: String = unsafe { String::from_utf8_unchecked(name) };
            name.make_ascii_lowercase();
            Ok(Self { name })
        } else {
            Err(InvalidDomainName::new(name))
        }
    }
}

impl TryFrom<&[u8]> for Domain {
    type Error = ParseError;

    fn try_from(name: &[u8]) -> Result<Self, Self::Error> {
        if Self::is_valid_name(name, false) {
            let name: &str = unsafe { std::str::from_utf8_unchecked(name) };
            let name: String = name.to_string();
            Ok(Self { name })
        } else if Self::is_valid_name(name, true) {
            let name: &str = unsafe { std::str::from_utf8_unchecked(name) };
            let name: String = name.to_ascii_lowercase();
            Ok(Self { name })
        } else {
            Err(InvalidDomain)
        }
    }
}

impl<'a> From<DomainRef<'a>> for Domain {
    fn from(domain: DomainRef) -> Self {
        domain.to_domain()
    }
}

impl From<Domain> for String {
    fn from(domain: Domain) -> Self {
        domain.name
    }
}

impl Domain {
    //! Properties

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

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

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

    #[test]
    fn try_from_string() {
        let result: Result<Domain, InvalidDomainName<String>> =
            Domain::try_from("localhost".to_string());
        assert_eq!(result, Ok(Domain::localhost()));

        let result: Result<Domain, InvalidDomainName<String>> =
            Domain::try_from("LocalHost".to_string());
        assert_eq!(result, Ok(Domain::localhost()));

        let result: Result<Domain, InvalidDomainName<String>> =
            Domain::try_from("Local!Host".to_string());
        assert_eq!(
            result.map_err(|e| e.into_name()),
            Err("Local!Host".to_string())
        );
    }

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

        let result: Result<Domain, ParseError> = Domain::try_from("LocalHost");
        assert_eq!(result, Ok(Domain::localhost()));

        let result: Result<Domain, ParseError> = Domain::try_from("Local!Host");
        assert_eq!(result, Err(InvalidDomain));
    }

    #[test]
    fn try_from_vec() {
        let result: Result<Domain, InvalidDomainName<Vec<u8>>> =
            Domain::try_from(Vec::from("localhost"));
        assert_eq!(result, Ok(Domain::localhost()));

        let result: Result<Domain, InvalidDomainName<Vec<u8>>> =
            Domain::try_from(Vec::from("LocalHost"));
        assert_eq!(result, Ok(Domain::localhost()));

        let result: Result<Domain, InvalidDomainName<Vec<u8>>> =
            Domain::try_from(Vec::from("Local!Host"));
        assert_eq!(
            result.map_err(|e| e.into_name()),
            Err(Vec::from("Local!Host"))
        );
    }

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

        let result: Result<Domain, ParseError> = Domain::try_from("LocalHost".as_bytes());
        assert_eq!(result, Ok(Domain::localhost()));

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

    #[test]
    fn from_ref() {
        let domain: DomainRef = DomainRef::LOCALHOST;

        let result: Domain = domain.into();
        let expected: Domain = Domain::localhost();
        assert_eq!(result, expected);
    }

    #[test]
    fn deconstruction() {
        let domain: Domain = Domain::localhost();

        let result: String = domain.into();
        let expected: &str = "localhost";
        assert_eq!(result, expected);
    }

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