Struct TxtBuilder

pub struct TxtBuilder<Builder> { /* private fields */ }

Iteratively build TXT record data.

This type allows building TXT record data by starting with empty data and appending either complete character strings or slices of data.

Implementations

impl<Builder: OctetsBuilder + EmptyBuilder> TxtBuilder<Builder>

pub fn new() -> Self

Creates a new, empty TXT builder.

impl TxtBuilder<BytesMut>

pub fn new_bytes() -> Self

Creates a new, empty TXT builder using BytesMut.

impl<Builder: OctetsBuilder + AsRef<[u8]> + AsMut<[u8]>> TxtBuilder<Builder>

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

Appends a slice to the builder.

The method breaks up the slice into individual octets strings if necessary. If a previous call has started a new octets string, it fills this one up first before creating a new one. Thus, by using this method only, the resulting TXT record data will consist of character strings where all but the last one are 255 octets long.

You can force a character string break by calling close_charstr.

The method will return an error if appending the slice would result in exceeding the record data length limit or the underlying builder runs out of space. In this case, the method may have appended some data already. I.e., you should consider the builder corrupt if the method returns an error.

pub fn append_u8(&mut self, ch: u8) -> Result<(), TxtAppendError>

Appends a single octet.

This method calls append_slice, so all the caveats described there apply.

pub fn append_charstr<Octs: AsRef<[u8]> + ?Sized>( &mut self, s: &CharStr<Octs>, ) -> Result<(), TxtAppendError>

Appends a complete character string.

If a character string had previously been started by a call to append_slice, this string is closed before appending the provided character string.

The method will return an error if appending the slice would result in exceeding the record data length limit or the underlying builder runs out of space. In this case, the method may have appended some data already. I.e., you should consider the builder corrupt if the method returns an error.

pub fn close_charstr(&mut self)

Ends a character string.

If a previous call to append_slice started a new character string, a call to this method will close it.

pub fn finish(self) -> Result<Txt<Builder::Octets>, TxtAppendError>

where Builder: FreezeBuilder,

Finishes the builder and returns TXT record data.

If the builder is empty, appends an empty character string before returning. If that fails because the builder does not have enough space, returns an error.

Trait Implementations

impl<Builder: Clone> Clone for TxtBuilder<Builder>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Builder: Debug> Debug for TxtBuilder<Builder>

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

Formats the value using the given formatter.

impl<Builder: OctetsBuilder + EmptyBuilder> Default for TxtBuilder<Builder>

fn default() -> Self

Returns the “default value” for a type.