Enum shelp::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
Grey	Black
Red	DarkRed
Green	DarkGreen
Yellow	DarkYellow
Blue	DarkBlue
Magenta	DarkMagenta
Cyan	DarkCyan
White	DarkWhite

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

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.

Fields of Rgb

r: u8g: u8b: u8

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<'a> Color

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

Parses an ANSI color sequence. For example:

• 5;0 -> Black,
• 5;26 -> AnsiValue(26),
• 2;50;60;70 -> Rgb(50, 60, 70). Invalid sequences map to None.

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

See also: Colored::parse_ansi

Trait Implementations

impl Clone for Color

pub fn clone(&self) -> Color

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Color

impl Debug for Color

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

Formats the value using the given formatter.

impl Eq for Color

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

pub fn from(val: (u8, u8, u8)) -> Color

Creates a 'Color' from the tuple representation.

impl FromStr for Color

type Err = ()

The associated error which can be returned from parsing.

pub fn from_str(src: &str) -> Result<Color, <Color as FromStr>::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.

impl Hash for Color

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Color

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Color> for Color

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

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

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

This method tests for !=.

impl PartialOrd<Color> for Color

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Color

impl StructuralPartialEq for Color

impl<'_> TryFrom<&'_ str> for Color

type Error = ()

The type returned in the event of a conversion error.

pub fn try_from(src: &str) -> Result<Color, <Color as TryFrom<&'_ str>>::Error>

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