Struct domain::base::name::Chain

pub struct Chain<L, R> { /* fields omitted */ }

Two domain names chained together.

This type is the result of calling the chain method on RelativeDname, UncertainDname, or on Chain itself.

The chain can be both an absolute or relative domain name—and implements the respective traits ToDname or ToRelativeDname—, depending on whether the second name is absolute or relative.

A chain on an uncertain name is special in that the second name is only used if the uncertain name is relative.

Implementations

impl<L: ToRelativeDname, R: ToEitherDname> Chain<L, R>

pub fn chain<N: ToEitherDname>(
    self,
    other: N
) -> Result<Chain<Self, N>, LongChainError>

Extends the chain with another domain name.

While the method accepts anything Compose as the second element of the chain, the resulting Chain will only implement ToDname or ToRelativeDname if if also implements ToDname or ToRelativeDname, respectively.

The method will fail with an error if the chained name is longer than 255 bytes.

impl<L, R> Chain<L, R>

pub fn unwrap(self) -> (L, R)

Unwraps the chain into its two constituent components.

Trait Implementations

impl<L: Clone, R: Clone> Clone for Chain<L, R>

fn clone(&self) -> Chain<L, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L: ToRelativeDname, R: ToEitherDname> Compose for Chain<L, R>

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, R: ToDname> Compose for Chain<UncertainDname<Octets>, R> where
    Octets: AsRef<[u8]>,
    R: ToDname, 

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<L: Debug, R: Debug> Debug for Chain<L, R>

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

Formats the value using the given formatter.

impl<L: Display, R: Display> Display for Chain<L, R>

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

Formats the value using the given formatter.

impl<L: ToRelativeDname, R: ToDname> ToDname for Chain<L, R>

fn to_dname<Octets>(&self) -> Result<Dname<Octets>, PushError> where
    Octets: FromBuilder,
    <Octets as FromBuilder>::Builder: EmptyBuilder, 

Converts the name into a single, uncompressed name.

fn as_flat_slice(&self) -> Option<&[u8]>

Returns an octets slice of the content if possible.

fn to_cow(&self) -> Dname<Cow<[u8]>>

Returns a cow of the domain name.

fn to_vec(&self) -> Dname<Vec<u8>>

Returns the domain name assembled into a Vec<u8>.

fn name_eq<N: ToDname + ?Sized>(&self, other: &N) -> bool

Tests whether self and other are equal.

fn name_cmp<N: ToDname + ?Sized>(&self, other: &N) -> Ordering

Returns the ordering between self and other.

fn composed_cmp<N: ToDname + ?Sized>(&self, other: &N) -> Ordering

Returns the composed name ordering.

fn lowercase_composed_cmp<N: ToDname + ?Sized>(&self, other: &N) -> Ordering

Returns the lowercase composed ordering.

fn rrsig_label_count(&self) -> u8

Returns the number of labels for the RRSIG Labels field.

impl<Octets, R> ToDname for Chain<UncertainDname<Octets>, R> where
    Octets: AsRef<[u8]>,
    R: ToDname, 

fn to_dname<Octets>(&self) -> Result<Dname<Octets>, PushError> where
    Octets: FromBuilder,
    <Octets as FromBuilder>::Builder: EmptyBuilder, 

Converts the name into a single, uncompressed name.

fn as_flat_slice(&self) -> Option<&[u8]>

Returns an octets slice of the content if possible.

fn to_cow(&self) -> Dname<Cow<[u8]>>

Returns a cow of the domain name.

fn to_vec(&self) -> Dname<Vec<u8>>

Returns the domain name assembled into a Vec<u8>.

fn name_eq<N: ToDname + ?Sized>(&self, other: &N) -> bool

Tests whether self and other are equal.

fn name_cmp<N: ToDname + ?Sized>(&self, other: &N) -> Ordering

Returns the ordering between self and other.

fn composed_cmp<N: ToDname + ?Sized>(&self, other: &N) -> Ordering

Returns the composed name ordering.

fn lowercase_composed_cmp<N: ToDname + ?Sized>(&self, other: &N) -> Ordering

Returns the lowercase composed ordering.

fn rrsig_label_count(&self) -> u8

Returns the number of labels for the RRSIG Labels field.

impl<'a, L: ToRelativeDname, R: ToEitherDname> ToLabelIter<'a> for Chain<L, R>

type LabelIter = ChainIter<'a, L, R>

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.

impl<'a, Octets, R> ToLabelIter<'a> for Chain<UncertainDname<Octets>, R> where
    Octets: AsRef<[u8]>,
    R: ToDname, 

type LabelIter = UncertainChainIter<'a, Octets, R>

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.

impl<L: ToRelativeDname, R: ToRelativeDname> ToRelativeDname for Chain<L, R>

fn to_relative_dname<Octets>(&self) -> Result<RelativeDname<Octets>, PushError> where
    Octets: FromBuilder,
    <Octets as FromBuilder>::Builder: EmptyBuilder, 

Converts the name into a single, continous name.

fn as_flat_slice(&self) -> Option<&[u8]>

Returns a byte slice of the content if possible.

fn to_cow(&self) -> RelativeDname<Cow<[u8]>>

Returns a cow of the relative domain name.

fn to_vec(&self) -> RelativeDname<Vec<u8>>

Returns the domain name assembled into a Vec<u8>.

fn is_empty(&self) -> bool

Returns whether the name is empty.

fn chain<N: ToEitherDname>(
    self,
    suffix: N
) -> Result<Chain<Self, N>, LongChainError> where
    Self: Sized, 

Returns a chain of this name and the provided name.

fn chain_root(self) -> Chain<Self, Dname<&'static [u8]>> where
    Self: Sized, 

Returns the absolute name by chaining it with the root label.

fn name_eq<N: ToRelativeDname + ?Sized>(&self, other: &N) -> bool

Tests whether self and other are equal.

fn name_cmp<N: ToRelativeDname + ?Sized>(&self, other: &N) -> Ordering

Returns the ordering between self and other.