Enum domain_core::bits::name::UncertainDname

pub enum UncertainDname {
    Absolute(Dname),
    Relative(RelativeDname),
}

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)Relative(RelativeDname)

Methods

impl UncertainDname

pub fn absolute(name: Dname) -> Self

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

pub fn relative(name: RelativeDname) -> Self

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

pub fn root() -> Self

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

pub fn empty() -> Self

Creates a new uncertain yet empty domain name.

pub fn from_chars<C>(chars: C) -> Result<Self, FromStrError> where
    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.

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>

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

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

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

pub fn try_into_absolute(self) -> Result<Dname, 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, Self>

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

Otherwise just returns itself as the error.

pub fn into_absolute(self) -> Dname

Converts the name into an absolute name.

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

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

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.

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

Returns a byte slice with the raw content of the name.

Trait Implementations

impl Compose for UncertainDname

fn compose_len(&self) -> usize

Returns the number of bytes this value will need without compression.

fn compose<B: BufMut>(&self, buf: &mut B)

Appends the uncompressed representation of this value to buf.

impl<'a> ToLabelIter<'a> for UncertainDname

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 starts_with<N: ToLabelIter<'a>>(&'a self, base: &'a N) -> bool

Determines whether base is a prefix of self.

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

Determines whether base is a suffix of self.

impl Scan for UncertainDname

fn scan<C: CharSource>(scanner: &mut Scanner<C>) -> Result<Self, ScanError>

Scans a value from a master file.

impl Eq for UncertainDname

impl Clone for UncertainDname

fn clone(&self) -> UncertainDname

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<UncertainDname> for UncertainDname

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

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

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

This method tests for !=.

impl From<Dname> for UncertainDname

fn from(name: Dname) -> Self

Performs the conversion.

impl From<RelativeDname> for UncertainDname

fn from(name: RelativeDname) -> Self

Performs the conversion.

impl Hash for UncertainDname

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 Debug for UncertainDname

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

Formats the value using the given formatter.

impl Display for UncertainDname

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

Formats the value using the given formatter.

impl FromStr for UncertainDname

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.