Struct text_style::StyledStr

pub struct StyledStr<'a> {
    pub s: &'a str,
    pub style: Option<Style>,
}

A borrowed string with an optional style annotation.

Example

let s = text_style::StyledStr::plain("test").bold();

let s1 = text_style::StyledStr::styled("test", text_style::Style::fg(text_style::AnsiColor::Red.dark()));
let s2 = text_style::StyledStr::plain("test").with(text_style::AnsiColor::Red.dark());
assert_eq!(s1, s2);

Fields

s: &'a str

The content of this string.

style: Option<Style>

The style of this string.

Implementations

impl<'a> StyledStr<'a>

pub fn new(s: &'a str, style: Option<Style>) -> StyledStr<'a>

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

pub fn styled(s: &'a str, style: Style) -> StyledStr<'a>

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

pub fn plain(s: &'a str) -> StyledStr<'a>

Creates a new styled string from the given string without a 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<'a> Clone for StyledStr<'a>

fn clone(&self) -> StyledStr<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for StyledStr<'a>

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

Formats the value using the given formatter.

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

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

Performs the conversion.

impl<'a, 'b> From<&'b (Style, &'a str)> for StyledStr<'a>

fn from((style, s): &'b (Style, &'a str)) -> StyledStr<'a>

Performs the conversion.

impl<'a, 'b> From<&'b StyledStr<'a>> for ANSIString<'a>

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

Performs the conversion.

impl<'a, 'b> From<&'b StyledStr<'a>> for StyledContent<&'a str>

fn from(s: &'b StyledStr<'a>) -> StyledContent<&'a str>

Performs the conversion.

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

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

Performs the conversion.

impl<'a, 'b> From<&'b StyledStr<'a>> for StyledStr<'a>

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

Performs the conversion.

impl<'a> From<(Style, &'a str)> for StyledStr<'a>

fn from((style, s): (Style, &'a str)) -> StyledStr<'a>

Performs the conversion.

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

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

Performs the conversion.

impl<'a> From<StyledStr<'a>> for StyledContent<&'a str>

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<'a> PartialEq<StyledStr<'a>> for StyledStr<'a>

fn eq(&self, other: &StyledStr<'a>) -> bool

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

fn ne(&self, other: &StyledStr<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for StyledStr<'a>

impl<'a> Termion for StyledStr<'a>

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

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