Enum ansi_str::Color

pub enum Color {
    Black,
    BrightBlack,
    Red,
    BrightRed,
    Green,
    BrightGreen,
    Yellow,
    BrightYellow,
    Blue,
    BrightBlue,
    Purple,
    BrightPurple,
    Magenta,
    BrightMagenta,
    Cyan,
    BrightCyan,
    White,
    BrightWhite,
    Fixed(u8),
    Rgb(u8, u8, u8),
}

A color is one specific type of ANSI escape code, and can refer to either the foreground or background color.

These use the standard numeric sequences. See http://invisible-island.net/xterm/ctlseqs/ctlseqs.html

Variants

Black

Color #0 (foreground code 30, background code 40).

This is not necessarily the background color, and using it as one may render the text hard to read on terminals with dark backgrounds.

BrightBlack

Color #0 (foreground code 90, background code 100).

Red

Color #1 (foreground code 31, background code 41).

BrightRed

Color #1 (foreground code 91, background code 101).

Green

Color #2 (foreground code 32, background code 42).

BrightGreen

Color #2 (foreground code 92, background code 102).

Yellow

Color #3 (foreground code 33, background code 43).

BrightYellow

Color #3 (foreground code 93, background code 103).

Blue

Color #4 (foreground code 34, background code 44).

BrightBlue

Color #4 (foreground code 94, background code 104).

Purple

Color #5 (foreground code 35, background code 45).

BrightPurple

Color #5 (foreground code 95, background code 105).

Magenta

Color #5 (foreground code 35, background code 45).

BrightMagenta

Color #5 (foreground code 95, background code 105).

Cyan

Color #6 (foreground code 36, background code 46).

BrightCyan

Color #6 (foreground code 96, background code 106).

White

Color #7 (foreground code 37, background code 47).

As above, this is not necessarily the foreground color, and may be hard to read on terminals with light backgrounds.

BrightWhite

Color #7 (foreground code 97, background code 107).

Fixed(u8)

A color number from 0 to 255, for use in 256-color terminal environments.

• colors 0 to 7 are the Black to White variants respectively. These colors can usually be changed in the terminal emulator.
• colors 8 to 15 are brighter versions of the eight colors above. These can also usually be changed in the terminal emulator, or it could be configured to use the original colors and show the text in bold instead. It varies depending on the program.
• colors 16 to 231 contain several palettes of bright colors, arranged in six squares measuring six by six each.
• colors 232 to 255 are shades of grey from black to white.

It might make more sense to look at a color chart.

Rgb(u8, u8, u8)

A 24-bit Rgb color, as specified by ISO-8613-3.

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 From<AnsiColor> for Color

fn from(clr: AnsiColor) -> Self

Converts to this type from the input type.

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 Copy for Color

impl Eq for Color

impl StructuralEq for Color

impl StructuralPartialEq for Color