Enum domain::base::name::UncertainDname

pub enum UncertainDname<Octets> {
    Absolute(Dname<Octets>),
    Relative(RelativeDname<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(Dname<Octets>)

Relative(RelativeDname<Octets>)

Implementations

impl<Octets> UncertainDname<Octets>

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

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

pub fn relative(name: RelativeDname<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_chars<C>(chars: C) -> Result<Self, FromStrError> where
    Octets: FromBuilder,
    <Octets as FromBuilder>::Builder: EmptyBuilder,
    C: IntoIterator<Item = char>, 

Creates a domain name from a sequence of characters.

The sequence must result in a domain name in master format representation. That is, its labels should be separated by dots, 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 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.

impl UncertainDname<&'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 UncertainDname<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<Octets> UncertainDname<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<&Dname<Octets>>

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

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

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

pub fn into_absolute(
    self
) -> Result<Dname<<<Octets as IntoBuilder>::Builder as IntoOctets>::Octets>, PushError> where
    Octets: AsRef<[u8]> + IntoBuilder,
    <Octets as IntoBuilder>::Builder: IntoOctets<Octets = Octets>, 

Converts the name into an absolute name.

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

pub fn try_into_absolute(self) -> Result<Dname<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<RelativeDname<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: ToEitherDname>(
    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<Octets: AsRef<T>, T> AsRef<T> for UncertainDname<Octets>

fn as_ref(&self) -> &T

Performs the conversion.

impl<Octets: Clone> Clone for UncertainDname<Octets>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Octets: AsRef<[u8]>> Compose for UncertainDname<Octets>

fn compose<T: OctetsBuilder>(&self, target: &mut T) -> Result<(), ShortBuf>

Appends the concrete representation of the value to the target.

fn compose_canonical<T: OctetsBuilder>(
    &self,
    target: &mut T
) -> Result<(), ShortBuf>

Appends the canonical representation of the value to the target.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

impl<Octets> From<Dname<Octets>> for UncertainDname<Octets>

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

Performs the conversion.

impl<Octets> From<RelativeDname<Octets>> for UncertainDname<Octets>

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

Performs the conversion.

impl<Octets> FromStr for UncertainDname<Octets> where
    Octets: FromBuilder,
    <Octets as FromBuilder>::Builder: EmptyBuilder, 

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 UncertainDname<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, 

Feeds a slice of this type into the given [Hasher].

impl<'a, Octets: AsRef<[u8]>> IntoIterator for &'a UncertainDname<Octets>

type Item = &'a Label

The type of the elements being iterated over.

type IntoIter = DnameIter<'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<UncertainDname<Other>> for UncertainDname<Octets> where
    Octets: AsRef<[u8]>,
    Other: AsRef<[u8]>, 

fn eq(&self, other: &UncertainDname<Other>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, Octets: AsRef<[u8]>> ToLabelIter<'a> for UncertainDname<Octets>

type LabelIter = DnameIter<'a>

The type of the iterator over the labels.

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

Returns an iterator over the labels.

fn len(&'a self) -> usize

Returns the length in octets of the encoded name.

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

Determines whether base is a prefix of self.

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

Determines whether base is a suffix of self.