Struct crossterm::style::Colors

pub struct Colors {
    pub foreground: Option<Color>,
    pub background: Option<Color>,
}

Represents, optionally, a foreground and/or a background color.

It can be applied using the SetColors command.

It can also be created from a Colored value or a tuple of (Color, Color) in the order (foreground, background).

The then method can be used to combine Colors values.

For example:

use crossterm::style::{Color, Colors, Colored};

// An example color, loaded from a config, file in ANSI format.
let config_color = "38;2;23;147;209";

// Default to green text on a black background.
let default_colors = Colors::new(Color::Green, Color::Black);
// Load a colored value from a config and override the default colors
let colors = match Colored::parse_ansi(config_color) {
    Some(colored) => default_colors.then(&colored.into()),
    None => default_colors,
};

See Color.

Fields

foreground: Option<Color>

background: Option<Color>

Implementations

impl Colors

pub fn then(&self, other: &Colors) -> Colors

Returns a new Color which, when applied, has the same effect as applying self and then other.

impl Colors

pub fn new(foreground: Color, background: Color) -> Colors

Trait Implementations

impl Clone for Colors

pub fn clone(&self) -> Colors

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Colors

impl Debug for Colors

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

Formats the value using the given formatter.

impl Eq for Colors

impl From<Colored> for Colors

pub fn from(colored: Colored) -> Colors

Performs the conversion.

impl PartialEq<Colors> for Colors

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

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

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

This method tests for !=.

impl StructuralEq for Colors

impl StructuralPartialEq for Colors