Struct domain::base::charstr::CharStrBuilder

pub struct CharStrBuilder<Builder>(_);

A builder for a character string.

This type wraps an [OctetBuilder] and in turn implements the [OctetBuilder] trait, making sure that the content cannot grow beyond the 255 octet limit of a character string.

Implementations

impl<Builder: EmptyBuilder> CharStrBuilder<Builder>

pub fn new() -> Self

Creates a new empty builder with default capacity.

pub fn with_capacity(capacity: usize) -> Self

Creates a new empty builder with the given capacity.

impl<Builder: OctetsBuilder> CharStrBuilder<Builder>

pub fn from_builder(builder: Builder) -> Result<Self, CharStrError>

Creates a character string builder from an octet sequence.

If the octet sequence is longer than 255 octets, an error is returned.

impl CharStrBuilder<Vec<u8>>

pub fn new_vec() -> Self

Creates a new empty characater string builder atop an octets vec.

pub fn vec_with_capacity(capacity: usize) -> Self

Creates a new empty builder atop an octets vec with a given capacity.

impl<Builder: OctetsBuilder> CharStrBuilder<Builder>

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

Returns an octet slice of the string assembled so far.

pub fn finish(self) -> CharStr<Builder::Octets> where
    Builder: IntoOctets, 

Converts the builder into an imutable character string.

Trait Implementations

impl<Builder: AsMut<[u8]>> AsMut<[u8]> for CharStrBuilder<Builder>

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

Performs the conversion.

impl<Builder: OctetsBuilder> AsRef<[u8]> for CharStrBuilder<Builder>

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

Performs the conversion.

impl<Builder: Clone> Clone for CharStrBuilder<Builder>

fn clone(&self) -> CharStrBuilder<Builder>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Builder: EmptyBuilder> Default for CharStrBuilder<Builder>

fn default() -> Self

Returns the "default value" for a type.

impl<Builder: AsRef<[u8]>> Deref for CharStrBuilder<Builder>

type Target = [u8]

The resulting type after dereferencing.

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

Dereferences the value.

impl<Builder> DerefMut for CharStrBuilder<Builder> where
    Builder: AsRef<[u8]> + AsMut<[u8]>, 

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

Mutably dereferences the value.

impl<Builder: OctetsBuilder> OctetsBuilder for CharStrBuilder<Builder>

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 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 append_compressed_dname<N: ToDname>(
    &mut self,
    name: &N
) -> Result<(), ShortBuf>

Appends a domain name using name compression if supported.

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

Prepends some appended data with its length as a u16.