Struct Color 

pub struct Color {
    pub name: String,
    pub kind: ColorType,
    pub number: Option<u8>,
    pub triplet: Option<ColorTriplet>,
}

A parsed color. Mirrors rich.color.Color.

Fields

name: String

The original name/spec the color was created from.

kind: ColorType

number: Option<u8>

Palette index for Standard/EightBit/Windows.

triplet: Option<ColorTriplet>

Explicit RGB for Truecolor.

Implementations

impl Color

pub fn is_default(&self) -> bool

Whether this is the terminal default color. Port of Color.is_default.

pub fn default_color() -> Self

The terminal default color.

pub fn from_ansi(number: u8) -> Self

A color from an 8-bit ANSI number (0–15 standard, 16–255 palette). Port of Color.from_ansi.

pub fn from_rgb(red: u8, green: u8, blue: u8) -> Self

A truecolor from explicit RGB channels. Port of Color.from_rgb (via from_triplet): the name is the #rrggbb hex.

pub fn parse(color: &str) -> Result<Self>

Parse a color from a string spec.

Accepts: a standard color name, default, #rrggbb, rgb(r,g,b), and color(N). Mirrors the common paths of Color.parse.

pub fn get_truecolor(&self) -> Option<ColorTriplet>

Resolve this color to an RGB triplet, using the palettes for indexed colors.

Returns None only for ColorType::Default.

pub fn ansi_codes(&self, foreground: bool) -> Vec<String>

The SGR parameter list for this color (without the leading \x1b[).

Port of Color.get_ansi_codes.

pub fn downgrade(&self, system: ColorSystem) -> Color

Return a version of this color representable in system.

Port of the reducing half of Color.downgrade: colors are only ever converted down to a smaller system, never up.

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a duplicate 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 Eq for Color

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Color