Struct domain::base::name::Chain

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

Two domain names chained together.

This type is the result of calling RelativeName::chain, UncertainName::chain, or Chain::chain.

The chain can be both an absolute or relative domain name—and implements the respective traits ToName or ToRelativeName—, 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, R> Chain<L, R>

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

impl<L: ToRelativeName, R: ToLabelIter> Chain<L, R>

pub fn chain<N: ToLabelIter>( 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 ToName or ToRelativeName if if also implements ToName or ToRelativeName, respectively.

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

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

where Self: ToLabelIter,

pub fn fmt_with_dot(&self) -> impl Display + '_

Returns an object that displays an absolute name with a final dot.

The chain itself displays without a final dot unless the chain results in an absolute name with the root label only. This method can be used to display a chain that results in an absolute name with a single dot at its end.

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

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

Formats the value using the given formatter.

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

where Self: ToLabelIter,

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

Formats the value using the given formatter.

impl<L, R, Target> FlattenInto<Name<Target>> for Chain<L, R>

where L: ToRelativeName, R: ToName + FlattenInto<Name<Target>, AppendError = BuilderAppendError<Target>>, Target: FromBuilder, <Target as FromBuilder>::Builder: EmptyBuilder,

type AppendError = <<Target as FromBuilder>::Builder as OctetsBuilder>::AppendError

fn try_flatten_into(self) -> Result<Name<Target>, Self::AppendError>

impl<L: ToRelativeName, R: ToLabelIter> ToLabelIter for Chain<L, R>

type LabelIter<'a> = ChainIter<'a, L, R> where L: 'a, R: '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<Octs, R> ToLabelIter for Chain<UncertainName<Octs>, R>

where Octs: AsRef<[u8]>, R: ToName,

type LabelIter<'a> = UncertainChainIter<'a, Octs, R> where Octs: 'a, R: '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<L: ToRelativeName, R: ToName> ToName for Chain<L, R>

fn try_to_name<Octets>( &self, ) -> Result<Name<Octets>, BuilderAppendError<Octets>>

where Octets: FromBuilder, <Octets as FromBuilder>::Builder: EmptyBuilder,

Converts the name into a single, uncompressed name.

fn to_name<Octets>(&self) -> Name<Octets>

where Octets: FromBuilder, <Octets as FromBuilder>::Builder: OctetsBuilder<AppendError = Infallible> + EmptyBuilder,

Converts the name into a single, uncompressed name.

fn try_to_canonical_name<Octets>( &self, ) -> Result<Name<Octets>, BuilderAppendError<Octets>>

where Octets: FromBuilder, <Octets as FromBuilder>::Builder: EmptyBuilder,

Converts the name into a single name in canonical form.

fn to_canonical_name<Octets>(&self) -> Name<Octets>

where Octets: FromBuilder, <Octets as FromBuilder>::Builder: OctetsBuilder<AppendError = Infallible> + EmptyBuilder,

Converts the name into a single name in canonical form.

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

Returns an octets slice of the content if possible.

fn compose<Target: OctetsBuilder + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

fn compose_canonical<Target: OctetsBuilder + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

fn to_cow(&self) -> Name<Cow<'_, [u8]>>

Returns a cow of the domain name.

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

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

fn to_bytes(&self) -> Name<Bytes>

Returns the domain name assembled into a bytes value.

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

Tests whether self and other are equal.

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

Returns the ordering between self and other.

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

Returns the composed name ordering.

fn lowercase_composed_cmp<N: ToName + ?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> ToName for Chain<UncertainName<Octets>, R>

where Octets: AsRef<[u8]>, R: ToName,

fn try_to_name<Octets>( &self, ) -> Result<Name<Octets>, BuilderAppendError<Octets>>

where Octets: FromBuilder, <Octets as FromBuilder>::Builder: EmptyBuilder,

Converts the name into a single, uncompressed name.

fn to_name<Octets>(&self) -> Name<Octets>

where Octets: FromBuilder, <Octets as FromBuilder>::Builder: OctetsBuilder<AppendError = Infallible> + EmptyBuilder,

Converts the name into a single, uncompressed name.

fn try_to_canonical_name<Octets>( &self, ) -> Result<Name<Octets>, BuilderAppendError<Octets>>

where Octets: FromBuilder, <Octets as FromBuilder>::Builder: EmptyBuilder,

Converts the name into a single name in canonical form.

fn to_canonical_name<Octets>(&self) -> Name<Octets>

where Octets: FromBuilder, <Octets as FromBuilder>::Builder: OctetsBuilder<AppendError = Infallible> + EmptyBuilder,

Converts the name into a single name in canonical form.

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

Returns an octets slice of the content if possible.

fn compose<Target: OctetsBuilder + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

fn compose_canonical<Target: OctetsBuilder + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

fn to_cow(&self) -> Name<Cow<'_, [u8]>>

Returns a cow of the domain name.

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

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

fn to_bytes(&self) -> Name<Bytes>

Returns the domain name assembled into a bytes value.

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

Tests whether self and other are equal.

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

Returns the ordering between self and other.

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

Returns the composed name ordering.

fn lowercase_composed_cmp<N: ToName + ?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<L: ToRelativeName, R: ToRelativeName> ToRelativeName for Chain<L, R>

fn try_to_relative_name<Octets>( &self, ) -> Result<RelativeName<Octets>, BuilderAppendError<Octets>>

where Octets: FromBuilder, <Octets as FromBuilder>::Builder: EmptyBuilder,

Converts the name into a single, continous name.

fn to_relative_name<Octets>(&self) -> RelativeName<Octets>

where Octets: FromBuilder, <Octets as FromBuilder>::Builder: OctetsBuilder<AppendError = Infallible> + EmptyBuilder,

Converts the name into a single, continous name.

fn try_to_canonical_relative_name<Octets>( &self, ) -> Result<RelativeName<Octets>, BuilderAppendError<Octets>>

where Octets: FromBuilder, <Octets as FromBuilder>::Builder: EmptyBuilder,

Converts the name into a single name in canonical form.

fn to_canonical_relative_name<Octets>(&self) -> RelativeName<Octets>

where Octets: FromBuilder, <Octets as FromBuilder>::Builder: OctetsBuilder<AppendError = Infallible> + EmptyBuilder,

Converts the name into a single name in canonical form.

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

Returns a byte slice of the content if possible.

fn compose<Target: OctetsBuilder + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

fn compose_canonical<Target: OctetsBuilder + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

fn to_cow(&self) -> RelativeName<Cow<'_, [u8]>>

Returns a cow of the relative domain name.

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

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

fn to_bytes(&self) -> RelativeName<Bytes>

Returns the domain name assembled into a bytes value.

fn is_empty(&self) -> bool

Returns whether the name is empty.

fn chain<N: ToLabelIter>( 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, Name<&'static [u8]>>

where Self: Sized,

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

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

Tests whether self and other are equal.

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

Returns the ordering between self and other.