Struct domain::base::charstr::CharStrBuilder

pub struct CharStrBuilder<Builder>(_);

A builder for a character string.

This type wraps an OctetsBuilder and in turn implements the OctetsBuilder 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 + AsRef<[u8]>> 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 CharStrBuilder<BytesMut>

pub fn new_bytes() -> Self

Creates a new empty builder for a bytes value.

pub fn bytes_with_capacity(capacity: usize) -> Self

Creates a new empty builder for a bytes value with a given capacity.

impl<Builder> CharStrBuilder<Builder>

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

Returns an octet slice of the string assembled so far.

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

Converts the builder into an imutable character string.

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

pub fn len(&self) -> usize

Returns the length of the assembled character string.

This is the length of the content only, i.e., without the extra length octet added for the wire format.

pub fn is_empty(&self) -> bool

Returns whether the character string is empty.

Trait Implementations

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

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

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

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

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

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

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> OctetsBuilder for CharStrBuilder<Builder>where Builder: OctetsBuilder + AsRef<[u8]>,

type AppendError = ShortBuf

The error type when appending data fails.

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

Appends the content of a slice to the builder.

impl<Builder: Truncate> Truncate for CharStrBuilder<Builder>

fn truncate(&mut self, len: usize)

Truncate the sequence to len octets.