Struct domain::base::message_builder::TreeCompressor

pub struct TreeCompressor<Target> { /* private fields */ }

A domain name compressor that uses a tree.

This type wraps around an octets builder and implements domain name compression for it. It stores the position of any domain name it has seen in a binary tree.

The position of a domain name is calculated relative to the beginning of the underlying octets builder. This means that this builder must represent the message only. This means that if you are using the StreamTarget, you need to place it inside this type, not the other way around.

Implementations

impl<Target> TreeCompressor<Target>

pub fn new(target: Target) -> Self

Creates a new compressor from an underlying octets builder.

pub fn as_target(&self) -> &Target

Returns a reference to the underlying octets builder.

pub fn into_target(self) -> Target

Converts the compressor into the underlying octets builder.

pub fn as_slice(&self) -> &[u8]where
    Target: AsRef<[u8]>,

Returns an octets slice of the data.

pub fn as_slice_mut(&mut self) -> &mut [u8]where
    Target: AsMut<[u8]>,

Returns an mutable octets slice of the data.

Trait Implementations

impl<Target: AsMut<[u8]>> AsMut<[u8]> for TreeCompressor<Target>

fn as_mut(&mut self) -> &mut [u8]

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

impl<Target: AsRef<[u8]>> AsRef<[u8]> for TreeCompressor<Target>

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

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

impl<Target: Clone> Clone for TreeCompressor<Target>

fn clone(&self) -> TreeCompressor<Target>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Target: Debug> Debug for TreeCompressor<Target>

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

Formats the value using the given formatter.

impl<Target> OctetsBuilder for TreeCompressor<Target>where
    Target: OctetsBuilder + AsMut<[u8]>,

type Octets = <Target as OctetsBuilder>::Octets

The type of the octets the builder can be converted into.

fn append_slice(&mut self, slice: &[u8]) -> Result<(), ShortBuf>

Appends the content of a slice to the builder.

fn truncate(&mut self, len: usize)

Truncates the builder back to a length of len octets.

fn append_compressed_dname<N: ToDname>(
    &mut self,
    name: &N
) -> Result<(), ShortBuf>

Appends a domain name using name compression if supported.

fn freeze(self) -> Self::Octets

Converts the builder into immutable octets.

fn len(&self) -> usize

Returns the length of the already assembled data.

fn is_empty(&self) -> bool

Returns whether the builder is currently empty.

fn append_all<F>(&mut self, op: F) -> Result<(), ShortBuf>where
    F: FnOnce(&mut Self) -> Result<(), ShortBuf>,

Appends all data or nothing.

fn u16_len_prefixed<F>(&mut self, op: F) -> Result<(), ShortBuf>where
    Self: AsMut<[u8]>,
    F: FnOnce(&mut Self) -> Result<(), ShortBuf>,

Prepends some appended data with its length as a u16.