Struct duat_core::text::Builder

pub struct Builder { /* private fields */ }

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

The generation of text by the [TextBuilder] has a few peculiarities that are convenient in the situations where it is useful:

• The user cannot insert Tags directly, only by appending and modifying existing tags.
• All Tags that are appended result in an inverse Tag being placed before the next one, or at the end of the [Tags] (e.g. Tag::PushForm would be followed a Tag::PopForm).
• You can insert swappable text with [push_swappable()][Self::push_swappable].

These properties allow for quick and easy modification of the Text within, which can then be accessed with text.

Implementations

impl Builder

pub fn new() -> Self

pub fn finish(self) -> Text

pub fn push_str(&mut self, display: impl Display)

pub fn push_tag(&mut self, tag: Tag) -> Option<ToggleId>

Pushes a Tag to the end of the list of Tags, as well as its inverse at the end of the Text.

pub fn push_text(&mut self, text: Text)

pub fn push_part<D: Display>(&mut self, part: BuilderPart<D>)

pub fn clear(&mut self)

Trait Implementations

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.