Struct Builder

pub struct Builder { /* private fields */ }

Builds and modifies a Text, based on replacements applied to it.

This struct is meant to be used alongside the text! family of macros. You pass it as the first argument, and the Text will be extended by the macro. This lets you write a Text with multiple macro invocations:

fn is_more_than_two(num: usize) -> Text {
    let mut builder = Text::builder();
    hint!(builder, "The number " [*a] num [] " is ");
    if num > 2 {
        hint!(builder, [*a] "more" [] " than 2.");
    } else {
        hint!(builder, [*a] "not more" [] " than 2.");
    }
    builder.finish()
}

Implementations

impl Builder

pub fn new() -> Self

Returns a new instance of Builder

Use Text::builder if you don’t want to bring Builder into scope.

pub fn finish(self) -> Text

Finish construction and returns the Text

Will also finish the last Form tag, pushing a PopForm at the very end.

pub fn push<D: Display>(&mut self, part: impl Into<BuilderPart<D>>)

Pushes a part of the text

This can be an impl Display type, a Data type holding an impl Display or a tag surrogate.

pub fn last_was_empty(&self) -> bool

Wether or not the last added piece was empty

This happens when an empty String or an empty Text is pushed.

Trait Implementations

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.