Struct StyledStringBuilder 

pub struct StyledStringBuilder { /* private fields */ }

Builder for StyledStrings.

A builder can be initialized from scratch via StyledString::builder() or Default. Alternatively, it can be initialized from an existing StyledString. A builder can be extended by pushing text, styles or StyledStrings into it.

Examples

let mut builder = StyledString::builder();
builder.push_style(AnsiColor::BrightGreen.on(AnsiColor::White).bold());
builder.push_text("Hello");
builder.push_text(",");
// It's possible to use `+=` as syntactic sugar for `push_str()` / `push_style()`.
builder += Style::new();
builder.push_text(" world");
builder += styled!("[[it, dim]]!");

let s = builder.build();
assert_eq!(
    s.to_string(),
    "[[bold green! on white]]Hello,[[/]] world[[italic dim]]!"
);

Implementations

impl StyledStringBuilder

pub fn text(&self) -> &str

Returns the current string text.

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

Pushes unstyled text at the end of the string.

Panics

Panics if text contains an ANSI escape char (\x1b).

pub fn push_style(&mut self, style: Style)

Pushes a style at the end of this string.

pub fn push_str(&mut self, s: StyledStr<'_>)

Pushes a styled string at the end of this string.

pub fn build(self) -> StyledString

Finalizes the StyledString.

Trait Implementations

impl AddAssign<Style> for StyledStringBuilder

fn add_assign(&mut self, rhs: Style)

Performs the += operation.

impl AddAssign<StyledStr<'_>> for StyledStringBuilder

fn add_assign(&mut self, rhs: StyledStr<'_>)

Performs the += operation.

impl Clone for StyledStringBuilder

fn clone(&self) -> StyledStringBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StyledStringBuilder

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

Formats the value using the given formatter.

impl Default for StyledStringBuilder

fn default() -> StyledStringBuilder

Returns the “default value” for a type.

impl From<StyledString> for StyledStringBuilder

fn from(string: StyledString) -> Self

Converts to this type from the input type.