Enum crossterm::Colored

pub enum Colored {
    Fg(Color),
    Bg(Color),
}

Could be used to color the foreground or background color.

Colored::Fg represents the foreground color. Color::Bg represents the background color.

Example

You can use Colored in a write statement to apply the attribute to the terminal output.

println!("{} Red foreground color", Colored::Fg(Color::Red));
println!("{} Blue background color", Colored::Bg(Color::Blue));

You can also call coloring functions on a &'static str:

let styled_text = "Red forground color on blue background.".red().on_blue();
println!("{}", styled_text);

Variants

Fg(Color)

Bg(Color)

Trait Implementations

impl PartialOrd<Colored> for Colored

fn partial_cmp(&self, other: &Colored) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Colored) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Colored) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Colored) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Colored) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for Colored

fn cmp(&self, other: &Colored) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for Colored

impl Hash for Colored

fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Clone for Colored

fn clone(&self) -> Colored

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Colored

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

Formats the value using the given formatter.

impl Copy for Colored

impl Display for Colored

fn fmt(&self, _f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq<Colored> for Colored

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

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

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

This method tests for !=.