Struct Color 

pub struct Color { /* private fields */ }

Full set of named ANSI colors. Use Color::name_to_index() to look up. A terminal color.

Can be one of: default (inherit), a standard ANSI name, an 8-bit palette index, or a 24-bit true-color RGB triple.

Implementations

impl Color

pub const fn default() -> Self

Create a “default” color (inherit from parent).

pub fn from_ansi_name(name: &str) -> Option<Self>

Create from an ANSI standard name (e.g. “red”, “bright_blue”).

pub fn from_8bit(n: u8) -> Self

Create from an 8-bit (256) palette index.

pub fn from_rgb(r: u8, g: u8, b: u8) -> Self

Create from 24-bit RGB components.

pub fn from_hex(hex: &str) -> Result<Self, ColorParseError>

Create from a hex string like “#ff0000” or “ff0000”.

pub fn parse(s: &str) -> Result<Self, ColorParseError>

Parse a color from a string (name, hex, or “default”).

pub fn is_default(&self) -> bool

Is this the default/inherit color?

pub fn from_triplet(triplet: &ColorTriplet) -> Self

Create a Color from a ColorTriplet.

Examples

use rusty_rich::color::{Color, ColorTriplet};

let triplet = ColorTriplet::new(255, 0, 0);
let color = Color::from_triplet(&triplet);
assert!(!color.is_default());

pub fn is_system_defined(&self) -> bool

Returns true if this is a system-defined (non-custom) color.

System-defined colors are standard ANSI colors or named 8-bit palette entries. TrueColor and Default colors are not system-defined.

pub fn get_ansi_codes( &self, background: bool, ) -> (Option<String>, Option<String>)

Get the ANSI escape codes for this color as a foreground/background pair.

Returns (foreground_code, background_code) as decimal strings suitable for use in SGR sequences like \x1b[38;5;<code>m.

Examples

use rusty_rich::Color;

let red = Color::parse("red").unwrap();
let (fg, bg) = red.get_ansi_codes(false);
assert_eq!(fg, Some("31".to_string()));

pub fn name(&self) -> Option<&'static str>

Get the name of this color, if it has one.

For Standard and EightBit colors that were created from a name, this returns the original name. For TrueColor and Default colors, returns None.

pub fn number(&self) -> Option<u8>

Get the ANSI palette number for this color, if applicable.

Returns Some(n) for Standard (0–15) and EightBit (0–255) colors. Returns None for TrueColor and Default colors.

pub fn triplet(&self) -> Option<(u8, u8, u8)>

Get the RGB triplet for this color, if it has one.

Returns Some((r, g, b)) for TrueColor colors. For Standard and EightBit colors, the palette is consulted to compute the equivalent RGB values. Returns None for Default colors.

pub fn get_truecolor(&self, theme: &TerminalTheme) -> (u8, u8, u8)

Get the RGB triplet if available (computes it for named/8-bit colors by looking up the palette).

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

Downgrade this color to the given color system.

impl Color

pub fn name_to_index(name: &str) -> Option<u8>

Look up a named color index.

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

impl Debug for Color

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

Formats the value using the given formatter.

impl Display 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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Color