Enum yansi::Color

pub enum Color {
    Unset,
    Default,
    Black,
    Red,
    Green,
    Yellow,
    Blue,
    Magenta,
    Cyan,
    White,
    Fixed(u8),
    RGB(u8, u8, u8),
}

An enum representing an ANSI color code.

Variants

Unset

No color has been set. Nothing is changed when applied.

Default

Terminal default #9. (foreground code 39, background code 49).

Black

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

Red

Red: #1 (foreground code 31, background code 41).

Green

Green: #2 (foreground code 32, background code 42).

Yellow

Yellow: #3 (foreground code 33, background code 43).

Blue

Blue: #4 (foreground code 34, background code 44).

Magenta

Magenta: #5 (foreground code 35, background code 45).

Cyan

Cyan: #6 (foreground code 36, background code 46).

White

White: #7 (foreground code 37, background code 47).

Fixed(u8)

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

RGB(u8, u8, u8)

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

Implementations

impl Color

pub fn paint<T>(self, item: T) -> Paint<T>

Constructs a new Paint structure that encapsulates item with the foreground color set to the color self.

use yansi::Color::Blue;

println!("This is going to be blue: {}", Blue.paint("yay!"));

pub fn style(self) -> Style

Constructs a new Style structure with the foreground color set to the color self.

use yansi::Color::Green;

let success = Green.style().bold();
println!("Hey! {}", success.paint("Success!"));

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

fn default() -> Self

Returns the “default value” for a 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