Struct Name

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

A Name represents a domain-name, which consists of character strings separated by dots.
Each section of a name is called label
ex: google.com consists of two labels google and com

A valid name contains only alphanumeric characters, hyphen (-), underscore (_) or dots (.) and must not exceed 255 characters. Each label must not exceed 63 characters.

Microsoft implementation allows unicode characters in the name content. To create a name with unicode characters, use Name::new_unchecked or Name::new_with_labels

Implementations

impl<'a> Name<'a>

pub fn new(name: &'a str) -> Result<Self>

Creates a new Name. Returns Result::<Name>::Ok if given name contents are valid.

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

Create a new Name without checking for size limits or contents

pub fn new_with_labels(labels: &[Label<'a>]) -> Self

Creates a new Name with given labels

Allows construction of labels with . in them.

pub fn is_link_local(&self) -> bool

Verify if name ends with .local.

pub fn iter(&'a self) -> Iter<'_, Label<'a>>

Returns an Iter of this Name Labels

pub fn is_subdomain_of(&self, other: &Name<'_>) -> bool

Returns true if self is a subdomain of other

pub fn without(&self, domain: &Name<'_>) -> Option<Name<'_>>

Returns the subdomain part of self, based on domain. If self is not a subdomain of domain, returns None

Example:

let name = Name::new_unchecked("sub.domain.local");
let domain = Name::new_unchecked("domain.local");

assert!(domain.without(&name).is_none());

let sub = name.without(&domain).unwrap();
assert_eq!(sub.to_string(), "sub")

pub fn into_owned<'b>(self) -> Name<'b>

Transforms the inner data into its owned type

pub fn get_labels(&self) -> &[Label<'_>]

Get the labels that compose this name

Trait Implementations

impl<'a> Clone for Name<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Name<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Name<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a [Label<'a>]> for Name<'a>

fn from(labels: &'a [Label<'a>]) -> Self

Converts to this type from the input type.

impl<'a, const N: usize> From<[Label<'a>; N]> for Name<'a>

fn from(labels: [Label<'a>; N]) -> Self

Converts to this type from the input type.

impl<'a> From<Name<'a>> for CNAME<'a>

fn from(value: Name<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Name<'a>> for MB<'a>

fn from(value: Name<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Name<'a>> for MD<'a>

fn from(value: Name<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Name<'a>> for MF<'a>

fn from(value: Name<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Name<'a>> for MG<'a>

fn from(value: Name<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Name<'a>> for MR<'a>

fn from(value: Name<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Name<'a>> for NS<'a>

fn from(value: Name<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Name<'a>> for NSAP_PTR<'a>

fn from(value: Name<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Name<'a>> for PTR<'a>

fn from(value: Name<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for Name<'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> PartialEq for Name<'a>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

type Error = SimpleDnsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> Eq for Name<'a>