Struct Color 

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

A parsed color. Mirrors rich.color.Color.

Fields

name: CompactString

The original name/spec the color was created from: a CompactString, kept inline up to 24 bytes, so a colour’s name (#rrggbb, bright_red) allocates nothing.

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. Port of Color.parse.

Accepts a color name from ANSI_COLOR_NAMES, default, #rrggbb, color(N) (one to three digits) and rgb(r,g,b), case-insensitively and ignoring surrounding whitespace. The errors carry upstream’s ColorParseError messages.

pub fn from_triplet(triplet: ColorTriplet) -> Self

A truecolor from a triplet; the name is its #rrggbb hex. Port of Color.from_triplet.

pub fn system(&self) -> ColorSystem

The native color system of this color: standard for the default color. Port of the Color.system property.

pub fn is_system_defined(&self) -> bool

Whether the terminal defines the actual color: true for the default, standard and Windows colors. Port of Color.is_system_defined.

pub fn get_truecolor_for( &self, theme: Option<&TerminalTheme>, foreground: bool, ) -> ColorTriplet

The RGB triplet this color shows as under theme (the default export theme when None). A standard color takes the theme’s ANSI color and the default color the theme’s foreground or background. Port of Color.get_truecolor(theme, foreground).

pub fn rich_text(&self) -> Text

The text upstream prints for a color: <color 'red' (standard)⬤ >, the dot in the color itself. Port of Color.__rich__.

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 Color.downgrade: colors are only ever converted down to a smaller system, never up, and a Windows console matches against the Windows 10 console palette (WINDOWS_PALETTE), not the standard one.

Trait Implementations

impl Clone for Color

fn clone(&self) -> Self

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: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Renderable for Color

A color prints as its description and a dot in the color. Port of Color.__rich__.

fn rich_render( &self, console: &Console, options: &ConsoleOptions, ) -> Vec<Segment>

fn measure(&self, console: &Console, options: &ConsoleOptions) -> Measurement

The (minimum, maximum) cell width this renderable wants. Port of __rich_measure__. The default is what upstream’s Measurement.get returns for a renderable without one: anything from nothing to the whole width, (0, max_width).

fn fit_to_measurement(&self) -> bool

Whether a top-level Console::print shrinks this renderable to its measured width. Upstream renders every top-level renderable at the full console width, so the default is false; an extension may opt in.

fn vertical(&self) -> Option<VerticalAlign>

The vertical alignment a Table cell holding this renderable uses in place of its column’s. Upstream reads getattr(renderable, "vertical", None); Align sets it.

fn print_end_line(&self, _options: &ConsoleOptions) -> bool

Whether a top-level print ends this renderable’s last line. This port’s renderables separate lines, where upstream’s end each line with "\n", so a print adds the final line break. A renderable whose upstream output stops without one (Screen, LiveRender, a Rule whose end has no newline) returns false, and the next output continues its last line. options are the print’s options.

impl StructuralPartialEq for Color