Struct Builder

pub struct Builder<'a, const N: usize> { /* private fields */ }

A struct to concatenate TokenStrings without allocating unnecessary memory on the heap.

The const generic parameter N should be set to the number of strings to concatenate. See the crate::concat! macro for a more comfortable way to use a Builder.

Memory:

Uses a static array of N pointers to TokenStrings and two 8 byte fields, so (N + 2) * 8 bytes, (N + 2) * 64 bits.

Implementations

impl<'a, const N: usize> Builder<'a, N>

pub fn iter(&'a self) -> BuilderIter<'a, N>

pub const fn new(s: &'a TokenString) -> Self

Create a new Builder from the given TokenString.

Use this to concatenate the given string with other strings.

Panics

Panics, if the number of strings to concatenate is set to 0.

pub const fn concat_unchecked(&mut self, s: &'a TokenString) -> &mut Self

Concatenate the given string at the end of the builder.

See also Builder::concat_checked for the version that checks for errors, or the trait method Concat::concat.

Panics

Panics, if the number of concatenated strings is bigger than the size reserved by the constant generic N of Builder.

pub const fn concat_checked( &mut self, s: &'a TokenString, ) -> Result<&mut Self, TkStrError>

Concatenate another string to the end of the builder.

See also Builder::concat_unchecked for the version that does not check for errors, or the trait method concat.

Errors

This function will return TkStrError::TooBig if the concatenated string is greater than MAX_LENGTH. If more than N, the const generic value of the Builder, strings are being concatenated, TkStrError::TooMany is returned.

pub fn collect_checked(self) -> Result<TokenString, TkStrError>

Collect all strings passed to this Builder.

Errors

Returns TkStrError::TooBig if the sum of all string lengths is greater than MAX_LENGTH.

pub fn collect_unchecked(self) -> TokenString

Collect all strings passed to this Builder.

Panics

If the concatenated string would be greater than MAX_LENGTH, this panics.

Trait Implementations

impl<'a, const N: usize> Clone for Builder<'a, N>

fn clone(&self) -> Builder<'a, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, const N: usize> Collect for &'a mut Builder<'a, N>

fn collect(self) -> Result<TokenString, TkStrError>

Actually concatenate all strings given to the Builder.

impl<'a, const N: usize> Concat<&'a TokenString> for &'a mut Builder<'a, N>

type Output = &'a mut Builder<'a, N>

fn concat(self, s: &'a TokenString) -> Result<Self::Output, TkStrError>

Concatenate another string to the end of the builder.

impl<'a, const N: usize> Debug for Builder<'a, N>

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

Formats the value using the given formatter.

impl<const N: usize> Display for Builder<'_, N>

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

Formats the value using the given formatter.

impl<'a, const N: usize> IntoIterator for &'a Builder<'a, N>

type IntoIter = BuilderIter<'a, N>

Which kind of iterator are we turning this into?

type Item = &'a TokenString

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, const N: usize> Copy for Builder<'a, N>