Enum crossterm::style::Color

pub enum Color {
    Reset,
    Black,
    DarkGrey,
    Red,
    DarkRed,
    Green,
    DarkGreen,
    Yellow,
    DarkYellow,
    Blue,
    DarkBlue,
    Magenta,
    DarkMagenta,
    Cyan,
    DarkCyan,
    White,
    Grey,
    Rgb {
        r: u8,
        g: u8,
        b: u8,
    },
    AnsiValue(u8),
}

Represents a color.

Platform-specific Notes

The following list of 16 base colors are available for almost all terminals (Windows 7 and 8 included).

Light	Dark
DarkGrey	Black
Red	DarkRed
Green	DarkGreen
Yellow	DarkYellow
Blue	DarkBlue
Magenta	DarkMagenta
Cyan	DarkCyan
White	Grey

Most UNIX terminals and Windows 10 consoles support additional colors. See Color::Rgb or Color::AnsiValue for more info.

Variants

Reset

Resets the terminal color.

Black

Black color.

DarkGrey

Dark grey color.

Red

Light red color.

DarkRed

Dark red color.

Green

Light green color.

DarkGreen

Dark green color.

Yellow

Light yellow color.

DarkYellow

Dark yellow color.

Blue

Light blue color.

DarkBlue

Dark blue color.

Magenta

Light magenta color.

DarkMagenta

Dark magenta color.

Cyan

Light cyan color.

DarkCyan

Dark cyan color.

White

White color.

Grey

Grey color.

Rgb

Fields

r: u8

g: u8

b: u8

An RGB color. See RGB color model for more info.

Most UNIX terminals and Windows 10 supported only. See Platform-specific notes for more info.

AnsiValue(u8)

An ANSI color. See 256 colors - cheat sheet for more info.

Most UNIX terminals and Windows 10 supported only. See Platform-specific notes for more info.

Implementations

impl Color

pub fn parse_ansi(ansi: &str) -> Option<Self>

Parses an ANSI color sequence.

Examples

use crossterm::style::Color;

assert_eq!(Color::parse_ansi("5;0"), Some(Color::Black));
assert_eq!(Color::parse_ansi("5;26"), Some(Color::AnsiValue(26)));
assert_eq!(Color::parse_ansi("2;50;60;70"), Some(Color::Rgb { r: 50, g: 60, b: 70 }));
assert_eq!(Color::parse_ansi("invalid color"), None);

Currently, 3/4 bit color values aren’t supported so return None.

See also: Colored::parse_ansi.

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Color

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Color

fn deserialize<D>(deserializer: D) -> Result<Color, D::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<(u8, u8, u8)> for Color

fn from(val: (u8, u8, u8)) -> Self

Creates a ‘Color’ from the tuple representation.

impl FromStr for Color

fn from_str(src: &str) -> Result<Self, Self::Err>

Creates a Color from the string representation.

Notes

• Returns Color::White in case of an unknown color.
• Does not return Err and you can safely unwrap.

type Err = ()

The associated error which can be returned from parsing.

impl Hash for Color

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Color

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Color> for Color

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Color> for Color

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

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

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

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

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

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

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

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

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

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

impl Serialize for Color

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Color

fn try_from(src: &str) -> Result<Self, Self::Error>

Try to create a Color from the string representation. This returns an error if the string does not match.

type Error = ()

The type returned in the event of a conversion error.

impl Copy for Color

impl Eq for Color

impl StructuralEq for Color

impl StructuralPartialEq for Color