Struct colored::ColoredString

pub struct ColoredString { /* fields omitted */ }

A string that may have color and/or style applied to it.

Implementations

impl ColoredString

pub fn fgcolor(&self) -> Option<Color>

Get the current background color applied.

let cstr = "".blue();
assert_eq!(cstr.fgcolor(), Some(Color::Blue));
let cstr = cstr.clear();
assert_eq!(cstr.fgcolor(), None);

pub fn bgcolor(&self) -> Option<Color>

Get the current background color applied.

let cstr = "".on_blue();
assert_eq!(cstr.bgcolor(), Some(Color::Blue));
let cstr = cstr.clear();
assert_eq!(cstr.bgcolor(), None);

pub fn style(&self) -> Style

Get the current Style which can be check if it contains a Styles.

let colored = "".bold().italic();
assert_eq!(colored.style().contains(Styles::Bold), true);
assert_eq!(colored.style().contains(Styles::Italic), true);
assert_eq!(colored.style().contains(Styles::Dimmed), false);

pub fn is_plain(&self) -> bool

Checks if the colored string has no color or styling.

let cstr = "".red();
assert_eq!(cstr.is_plain(), false);
let cstr = cstr.clear();
assert_eq!(cstr.is_plain(), true);

Trait Implementations

impl Clone for ColoredString

fn clone(&self) -> ColoredString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Colorize for ColoredString

fn color<S: Into<Color>>(self, color: S) -> ColoredString

fn on_color<S: Into<Color>>(self, color: S) -> ColoredString

fn clear(self) -> ColoredString

fn normal(self) -> ColoredString

fn bold(self) -> ColoredString

fn dimmed(self) -> ColoredString

fn italic(self) -> ColoredString

fn underline(self) -> ColoredString

fn blink(self) -> ColoredString

fn reverse(self) -> ColoredString

Historical name of Colorize::reversed. May be removed in a future version. Please use Colorize::reversed instead

fn reversed(self) -> ColoredString

This should be preferred to Colorize::reverse.

fn hidden(self) -> ColoredString

fn strikethrough(self) -> ColoredString

fn black(self) -> ColoredString where
    Self: Sized, 

fn red(self) -> ColoredString where
    Self: Sized, 

fn green(self) -> ColoredString where
    Self: Sized, 

fn yellow(self) -> ColoredString where
    Self: Sized, 

fn blue(self) -> ColoredString where
    Self: Sized, 

fn magenta(self) -> ColoredString where
    Self: Sized, 

fn purple(self) -> ColoredString where
    Self: Sized, 

fn cyan(self) -> ColoredString where
    Self: Sized, 

fn white(self) -> ColoredString where
    Self: Sized, 

fn bright_black(self) -> ColoredString where
    Self: Sized, 

fn bright_red(self) -> ColoredString where
    Self: Sized, 

fn bright_green(self) -> ColoredString where
    Self: Sized, 

fn bright_yellow(self) -> ColoredString where
    Self: Sized, 

fn bright_blue(self) -> ColoredString where
    Self: Sized, 

fn bright_magenta(self) -> ColoredString where
    Self: Sized, 

fn bright_purple(self) -> ColoredString where
    Self: Sized, 

fn bright_cyan(self) -> ColoredString where
    Self: Sized, 

fn bright_white(self) -> ColoredString where
    Self: Sized, 

fn on_black(self) -> ColoredString where
    Self: Sized, 

fn on_red(self) -> ColoredString where
    Self: Sized, 

fn on_green(self) -> ColoredString where
    Self: Sized, 

fn on_yellow(self) -> ColoredString where
    Self: Sized, 

fn on_blue(self) -> ColoredString where
    Self: Sized, 

fn on_magenta(self) -> ColoredString where
    Self: Sized, 

fn on_purple(self) -> ColoredString where
    Self: Sized, 

fn on_cyan(self) -> ColoredString where
    Self: Sized, 

fn on_white(self) -> ColoredString where
    Self: Sized, 

fn on_bright_black(self) -> ColoredString where
    Self: Sized, 

fn on_bright_red(self) -> ColoredString where
    Self: Sized, 

fn on_bright_green(self) -> ColoredString where
    Self: Sized, 

fn on_bright_yellow(self) -> ColoredString where
    Self: Sized, 

fn on_bright_blue(self) -> ColoredString where
    Self: Sized, 

fn on_bright_magenta(self) -> ColoredString where
    Self: Sized, 

fn on_bright_purple(self) -> ColoredString where
    Self: Sized, 

fn on_bright_cyan(self) -> ColoredString where
    Self: Sized, 

fn on_bright_white(self) -> ColoredString where
    Self: Sized, 

impl Debug for ColoredString

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

Formats the value using the given formatter.

impl Default for ColoredString

fn default() -> Self

Returns the “default value” for a type.

impl Deref for ColoredString

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl Display for ColoredString

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

Formats the value using the given formatter.

impl Eq for ColoredString

impl<'a> From<&'a str> for ColoredString

fn from(s: &'a str) -> Self

Performs the conversion.

impl PartialEq<ColoredString> for ColoredString

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

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

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

This method tests for !=.

impl StructuralEq for ColoredString

impl StructuralPartialEq for ColoredString