Struct Builder 

pub struct Builder {
    pub no_space_after_empty: bool,
    /* private fields */
}

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

This struct is meant to be used alongside the [txt!] macro, as you can just push more Text to the Builder py pushing another Builder, which can be returned by the [txt!] macro:

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

In the above call, you can see that num was interpolated, just like with println!, there are also Forms being applied to the Text. Each [] pair denotes a Form. These pairs follow the following rule:

• []: Will push the "default" Form, which is actually just removing prior Forms.
• [a]: Will push the "accent" Form.
• [{form}]: Will push the "{form}", where {form} can be any sequence of valid identifiers, separated by "."s.

Fields

no_space_after_empty: bool

Wether to collapse " "s after an empty element is pushed

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 build(self) -> Text

Finish construction and returns the Text

Will also finish the last Form and alignments pushed to the builder, as well as pushing a '\n' at the end, much like with regular Text construction.

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

Pushes a part of the text

This can be an impl Display type, an impl Tag, a FormId, a PathBuf, or even std::process::Output.

pub fn last_was_empty(&self) -> bool

Whether or not the last added piece was empty

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

pub fn push_str<D: Display>(&mut self, d: D)

Pushes an impl Display to the Text

If builder.no_space_after_empty is set to true and the argument is equal to " ", then it won’t be added if the previous argument was empty. This is useful especially in situations where you expect to be constructing a Text with spaces in between the elements (like in a status line), but you don’t want an empty element to just leave to space wide gap in between two non empty elements.

pub fn reset_form(&mut self)

Resets the Form

This is equivalent to pushing the default Form.

pub fn reset_alignment(&mut self)

Resets the Form

This is equivalent to pushing the default Form.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.

impl From<Builder> for BuilderPart

fn from(value: Builder) -> Self

Converts to this type from the input type.

impl From<Builder> for Text

fn from(value: Builder) -> Self

Converts to this type from the input type.