StyledStringBuilder

Struct StyledStringBuilder 

Source
pub struct StyledStringBuilder { /* private fields */ }
Expand description

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§

Source§

impl StyledStringBuilder

Source

pub fn text(&self) -> &str

Returns the current string text.

Source

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).

Source

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

Pushes a style at the end of this string.

Source

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

Pushes a styled string at the end of this string.

Source

pub fn build(self) -> StyledString

Finalizes the StyledString.

Trait Implementations§

Source§

impl AddAssign<Style> for StyledStringBuilder

Source§

fn add_assign(&mut self, rhs: Style)

Performs the += operation. Read more
Source§

impl AddAssign<StyledStr<'_>> for StyledStringBuilder

Source§

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

Performs the += operation. Read more
Source§

impl Clone for StyledStringBuilder

Source§

fn clone(&self) -> StyledStringBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StyledStringBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for StyledStringBuilder

Source§

fn default() -> StyledStringBuilder

Returns the “default value” for a type. Read more
Source§

impl From<StyledString> for StyledStringBuilder

Source§

fn from(string: StyledString) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.