Enum UncertainName

pub enum UncertainName<Octets> {
    Absolute(Name<Octets>),
    Relative(RelativeName<Octets>),
}

A domain name that may be absolute or relative.

This type is helpful when reading a domain name from some source where it may end up being absolute or not.

Variants

Absolute(Name<Octets>)

Relative(RelativeName<Octets>)

Implementations

impl<Octets> UncertainName<Octets>

pub fn absolute(name: Name<Octets>) -> Self

Creates a new uncertain domain name from an absolute domain name.

pub fn relative(name: RelativeName<Octets>) -> Self

Creates a new uncertain domain name from a relative domain name.

pub fn root() -> Self

where Octets: From<&'static [u8]>,

Creates a new uncertain domain name containing the root label only.

pub fn empty() -> Self

where Octets: From<&'static [u8]>,

Creates a new uncertain yet empty domain name.

pub fn from_octets(octets: Octets) -> Result<Self, UncertainDnameError>

where Octets: AsRef<[u8]>,

Creates a new domain name from its wire format representation.

The returned name will correctly be identified as an absolute or relative name.

pub fn from_chars<C>(chars: C) -> Result<Self, FromStrError>

where Octets: FromBuilder, <Octets as FromBuilder>::Builder: FreezeBuilder<Octets = Octets> + EmptyBuilder + AsRef<[u8]> + AsMut<[u8]>, C: IntoIterator<Item = char>,

Creates a domain name from a sequence of characters.

The sequence must result in a domain name in zone file representation. That is, its labels should be separated by dots, while actual dots, white space and backslashes should be escaped by a preceeding backslash, and any byte value that is not a printable ASCII character should be encoded by a backslash followed by its three digit decimal value.

If Internationalized Domain Names are to be used, the labels already need to be in punycode-encoded form.

If the last character is a dot, the name will be absolute, otherwise it will be relative.

If you have a string, you can also use the FromStr trait, which really does the same thing.

pub fn scan<S: Scanner<Name = Name<Octets>>>( scanner: &mut S, ) -> Result<Self, S::Error>

impl UncertainName<&'static [u8]>

pub fn empty_ref() -> Self

Creates an empty relative name atop a slice reference.

pub fn root_ref() -> Self

Creates an absolute name that is the root label atop a slice reference.

impl UncertainName<Vec<u8>>

pub fn empty_vec() -> Self

Creates an empty relative name atop a Vec<u8>.

pub fn root_vec() -> Self

Creates an absolute name from the root label atop a Vec<u8>.

impl UncertainName<Bytes>

pub fn empty_bytes() -> Self

Creates an empty relative name atop a bytes value.

pub fn root_bytes() -> Self

Creates an absolute name from the root label atop a bytes value.

impl<Octets> UncertainName<Octets>

pub fn is_absolute(&self) -> bool

Returns whether the name is absolute.

pub fn is_relative(&self) -> bool

Returns whether the name is relative.

pub fn as_absolute(&self) -> Option<&Name<Octets>>

Returns a reference to an absolute name, if this name is absolute.

pub fn as_relative(&self) -> Option<&RelativeName<Octets>>

Returns a reference to a relative name, if the name is relative.

pub fn into_absolute(self) -> Result<Name<Octets>, PushError>

where Octets: AsRef<[u8]> + IntoBuilder, <Octets as IntoBuilder>::Builder: FreezeBuilder<Octets = Octets> + AsRef<[u8]> + AsMut<[u8]>,

Converts the name into an absolute name.

If the name is relative, appends the root label to it using RelativeName::into_absolute.

pub fn try_into_absolute(self) -> Result<Name<Octets>, Self>

Converts the name into an absolute name if it is absolute.

Otherwise, returns itself as the error.

pub fn try_into_relative(self) -> Result<RelativeName<Octets>, Self>

Converts the name into a relative name if it is relative.

Otherwise just returns itself as the error.

pub fn as_octets(&self) -> &Octets

Returns a reference to the underlying octets sequence.

pub fn as_slice(&self) -> &[u8]

where Octets: AsRef<[u8]>,

Returns an octets slice with the raw content of the name.

pub fn chain<S: ToLabelIter>( self, suffix: S, ) -> Result<Chain<Self, S>, LongChainError>

where Octets: AsRef<[u8]>,

Makes an uncertain name absolute by chaining on a suffix if needed.

The method converts the uncertain name into a chain that will be absolute. If the name is already absolute, the chain will be the name itself. If it is relative, if will be the concatenation of the name and suffix.

Trait Implementations

impl<Octs: AsRef<[u8]>> AsRef<[u8]> for UncertainName<Octs>

fn as_ref(&self) -> &[u8]

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

impl<Octs> AsRef<Octs> for UncertainName<Octs>

fn as_ref(&self) -> &Octs

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

impl<Octets: Clone> Clone for UncertainName<Octets>

fn clone(&self) -> UncertainName<Octets>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Octets: AsRef<[u8]>> Debug for UncertainName<Octets>

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

Formats the value using the given formatter.

impl<Octets: AsRef<[u8]>> Display for UncertainName<Octets>

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

Formats the value using the given formatter.

impl<Octets> From<Name<Octets>> for UncertainName<Octets>

fn from(src: Name<Octets>) -> Self

Converts to this type from the input type.

impl<Octets> From<RelativeName<Octets>> for UncertainName<Octets>

fn from(src: RelativeName<Octets>) -> Self

Converts to this type from the input type.

impl<Octets> FromStr for UncertainName<Octets>

where Octets: FromBuilder, <Octets as FromBuilder>::Builder: EmptyBuilder + FreezeBuilder<Octets = Octets> + AsRef<[u8]> + AsMut<[u8]>,

type Err = FromStrError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<Octets: AsRef<[u8]>> Hash for UncertainName<Octets>

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, Octets: AsRef<[u8]>> IntoIterator for &'a UncertainName<Octets>

type Item = &'a Label

The type of the elements being iterated over.

type IntoIter = NameIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Octets, Other> PartialEq<UncertainName<Other>> for UncertainName<Octets>

where Octets: AsRef<[u8]>, Other: AsRef<[u8]>,

fn eq(&self, other: &UncertainName<Other>) -> 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<Octs: AsRef<[u8]>> ToLabelIter for UncertainName<Octs>

type LabelIter<'a> = NameIter<'a> where Octs: 'a

The type of the iterator over the labels.

fn iter_labels(&self) -> Self::LabelIter<'_>

Returns an iterator over the labels.

fn compose_len(&self) -> u16

Returns the length in octets of the encoded name.

fn starts_with<N: ToLabelIter + ?Sized>(&self, base: &N) -> bool

Determines whether base is a prefix of self.

fn ends_with<N: ToLabelIter + ?Sized>(&self, base: &N) -> bool

Determines whether base is a suffix of self.

impl<Octets: AsRef<[u8]>> Eq for UncertainName<Octets>