Struct DomainRef 

pub struct DomainRef<'a> { /* private fields */ }

A Domain reference.

Implementations

impl<'a> DomainRef<'a>

Special Domains

pub const LOCALHOST: Self

The localhost domain.

pub const EXAMPLE: Self

The example.com domain.

impl<'a> DomainRef<'a>

Construction

pub unsafe fn new_unchecked(name: &'a str) -> Self

Creates a new DomainRef.

Safety

The name must be valid and lowercase.

impl<'a> DomainRef<'a>

Properties

pub const fn name(self) -> &'a str

Gets the name.

impl<'a> DomainRef<'a>

Labels

pub const fn labels(self) -> Labels<'a>

Gets the labels.

impl<'a> DomainRef<'a>

Conversions

pub fn to_domain(self) -> Domain

Converts the domain reference to a domain.

pub fn to_endpoint(self, port: u16) -> Endpoint

Converts the domain reference to an endpoint with the port.

pub const fn to_endpoint_ref(self, port: u16) -> EndpointRef<'a>

Converts the domain reference to an endpoint reference with the port.

pub fn to_host(self) -> Host

Converts the domain reference to a host.

pub const fn to_host_ref(self) -> HostRef<'a>

Converts the domain reference to a host reference.

impl<'a> DomainRef<'a>

Parse

pub fn parse_text(text: &'a [u8]) -> Result<Self, ParseError>

Dot-separated labels of ASCII letters, digits, & dashes. (see Domain::is_valid_name) The name must already be in lowercase. Use Domain to parse mixed-case input.

impl<'a> DomainRef<'a>

International Domain Names

pub fn to_unicode(self) -> Result<String, ParseError>

Available on crate feature idna only.

Converts the domain name to its Unicode representation.

Returns an error if a label contains invalid punycode. (example: xn--a.example)

Trait Implementations

impl<'a> AsRef<str> for DomainRef<'a>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Borrow<str> for DomainRef<'a>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<'a> Clone for DomainRef<'a>

fn clone(&self) -> DomainRef<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for DomainRef<'a>

impl<'a> Debug for DomainRef<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for DomainRef<'a>

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

The string is borrowed from the input, so domain names must be lowercase and must not contain escape sequences. Use Domain to deserialize mixed-case or escaped input.

impl<'a> Display for DomainRef<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Eq for DomainRef<'a>

impl<'a> From<&'a Domain> for DomainRef<'a>

fn from(domain: &'a Domain) -> Self

Converts to this type from the input type.

impl<'a> From<DomainRef<'a>> for Domain

fn from(domain: DomainRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<DomainRef<'a>> for Host

fn from(domain: DomainRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<DomainRef<'a>> for HostRef<'a>

fn from(domain: DomainRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for DomainRef<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for DomainRef<'a>

fn cmp(&self, other: &DomainRef<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for DomainRef<'a>

fn eq(&self, other: &DomainRef<'a>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> PartialEq<&str> for DomainRef<'a>

fn eq(&self, other: &&str) -> bool

Compares the name exactly; domain names are lowercase, so mixed-case strings are never equal.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> PartialEq<Domain> for DomainRef<'a>

fn eq(&self, other: &Domain) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> PartialEq<DomainRef<'a>> for Domain

fn eq(&self, other: &DomainRef<'a>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> PartialEq<DomainRef<'a>> for &str

fn eq(&self, other: &DomainRef<'a>) -> bool

Compares the name exactly; domain names are lowercase, so mixed-case strings are never equal.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> PartialEq<DomainRef<'a>> for String

fn eq(&self, other: &DomainRef<'a>) -> bool

Compares the name exactly; domain names are lowercase, so mixed-case strings are never equal.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> PartialEq<String> for DomainRef<'a>

fn eq(&self, other: &String) -> bool

Compares the name exactly; domain names are lowercase, so mixed-case strings are never equal.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> PartialOrd for DomainRef<'a>

fn partial_cmp(&self, other: &DomainRef<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Serialize for DomainRef<'a>

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for DomainRef<'a>

impl<'a> TryFrom<&'a str> for DomainRef<'a>

fn try_from(text: &'a str) -> Result<Self, Self::Error>

Dot-separated labels of ASCII letters, digits, & dashes. (see Domain::is_valid_name) The name must already be in lowercase. Use Domain to parse mixed-case input.

type Error = ParseError

The type returned in the event of a conversion error.