Struct text_style::StyledString

pub struct StyledString {
    pub s: String,
    pub style: Option<Style>,
}

An owned string with an optional style annotation.

Example

let s = format!("Some number: {}", 42);

let s0 = text_style::StyledString::plain(s.clone()).bold();

let s1 = text_style::StyledString::styled(s.clone(), text_style::Style::fg(text_style::AnsiColor::Red.dark()));
let s2 = text_style::StyledString::plain(s.clone()).with(text_style::AnsiColor::Red.dark());
assert_eq!(s1, s2);

Fields

s: String

The content of this string.

style: Option<Style>

The style of this string.

Implementations

impl StyledString

pub fn new(s: String, style: Option<Style>) -> StyledString

Creates a new styled string from the given string and an optional style.

pub fn styled(s: String, style: Style) -> StyledString

Creates a new styled string from the given string and style.

pub fn plain(s: String) -> StyledString

Creates a new styled string from the given string and style.

pub fn with(self, fg: Color) -> Self

Sets the foreground color for this styled string.

pub fn on(self, bg: Color) -> Self

Sets the background color for this styled string.

pub fn bold(self) -> Self

Sets the bold effect for this styled string.

pub fn italic(self) -> Self

Sets the italic effect for this styled string.

pub fn underline(self) -> Self

Sets the underline effect for this styled string.

pub fn effect(self, effect: Effect) -> Self

Sets the given effect for this styled string.

pub fn style_mut(&mut self) -> &mut Style

Returns a mutable reference to the style of this string, creating a new style with the default settings if the style is currently None.

Trait Implementations

impl Clone for StyledString

fn clone(&self) -> StyledString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StyledString

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

Formats the value using the given formatter.

impl Default for StyledString

fn default() -> StyledString

Returns the "default value" for a type.

impl<'a> From<&'a StyledString> for StyledStr<'a>

fn from(s: &'a StyledString) -> StyledStr<'a>

Performs the conversion.

impl<'a> From<StyledStr<'a>> for StyledString

fn from(s: StyledStr<'a>) -> StyledString

Performs the conversion.

impl<'a> From<StyledString> for ANSIString<'a>

fn from(s: StyledString) -> ANSIString<'a>

Performs the conversion.

impl From<StyledString> for StyledContent<String>

fn from(s: StyledString) -> StyledContent<String>

Performs the conversion.

impl From<StyledString> for StyledString

fn from(s: StyledString) -> StyledString

Performs the conversion.

impl PartialEq<StyledString> for StyledString

fn eq(&self, other: &StyledString) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StyledString) -> bool

This method tests for !=.

impl StructuralPartialEq for StyledString

impl Termion for StyledString

fn termion(&self) -> TermionStr<'_>

Convert this string into a TermionStr that can be formatted with termion.