Struct Color256

pub struct Color256(pub u8);

Colors in a 256-value (8-bit) palette

Constants are provided for the initial 16 colors.

Color256 values can be parsed from case-insensitive names (see Color256::name()) or from strings of the form "color({index})".

Color256 values are displayed as their lowercase names or, for colors without names, as strings of the form "color({index})".

Examples

use parse_style::Color256;

assert_eq!("color(2)".parse::<Color256>().unwrap(), Color256(2));
assert_eq!("green".parse::<Color256>().unwrap(), Color256(2));
assert_eq!("GREEN".parse::<Color256>().unwrap(), Color256(2));

assert_eq!(Color256(2).to_string(), "green");
assert_eq!(Color256(42).to_string(), "color(42)");

Tuple Fields

0: u8

Implementations

impl Color256

pub const BLACK: Color256

Color 0

pub const RED: Color256

Color 1, also known as “dark red”

pub const GREEN: Color256

Color 2, also known as “dark green”

pub const YELLOW: Color256

Color 3, also known as “dark yellow”

pub const BLUE: Color256

Color 4, also known as “dark blue”

pub const MAGENTA: Color256

Color 5, also known as “dark magenta”

pub const CYAN: Color256

Color 6, also known as “dark cyan”

pub const WHITE: Color256

Color 7, also known as “grey”

pub const BRIGHT_BLACK: Color256

Color 8, also known as “dark grey” or “grey”

pub const BRIGHT_RED: Color256

Color 9

pub const BRIGHT_GREEN: Color256

Color 10

pub const BRIGHT_YELLOW: Color256

Color 11

pub const BRIGHT_BLUE: Color256

Color 12

pub const BRIGHT_MAGENTA: Color256

Color 13

pub const BRIGHT_CYAN: Color256

Color 14

pub const BRIGHT_WHITE: Color256

Color 15, also known as “white”

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

Return the lowercase name of the color as recognized by rich. See this page for the list of color names.

Note that not all colors have a name. Also note that some greyscale colors have two names, one using the spelling “gray” and the other “grey”; this method uses the “gray” spellings.

Examples

use parse_style::Color256;

assert_eq!(Color256::BRIGHT_YELLOW.name(), Some("bright_yellow"));
assert_eq!(Color256(42).name(), None);
assert_eq!(Color256(59).name(), Some("gray37"));
assert_eq!(Color256(118).name(), Some("chartreuse1"));

pub fn as_foreground(self) -> Style

Return a new Style that uses this color as the foreground color

pub fn as_background(self) -> Style

Return a new Style that uses this color as the background color

pub fn on<C: Into<Color>>(self, bg: C) -> Style

Return a new Style that uses this color as the foreground color and bg as the background color

Trait Implementations

impl Clone for Color256

fn clone(&self) -> Color256

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Color256

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Color256

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Color256

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

Formats the value using the given formatter.

impl From<Ansi256Color> for Color256

Available on crate feature anstyle only.

fn from(value: Ansi256Color) -> Color256

Convert an anstyle::Ansi256Color to a Color256

impl From<AnsiColor> for Color256

Available on crate feature anstyle only.

fn from(value: AnsiColor) -> Color256

Convert an anstyle::AnsiColor to a Color256

impl From<Color256> for Ansi256Color

Available on crate feature anstyle only.

fn from(value: Color256) -> Ansi256Color

Convert a Color256 to an anstyle::Ansi256Color

impl From<Color256> for Color

fn from(value: Color256) -> Color

Converts to this type from the input type.

impl From<Color256> for Color

Available on crate feature crossterm only.

fn from(value: Color256) -> Color

Convert a Color256 to a crossterm::style::Color

impl From<Color256> for Color

Available on crate feature ratatui only.

fn from(value: Color256) -> Color

Convert a Color256 to a ratatui::style::Color

impl From<Color256> for u8

fn from(value: Color256) -> u8

Converts to this type from the input type.

impl From<u8> for Color256

fn from(value: u8) -> Color256

Converts to this type from the input type.

impl FromStr for Color256

type Err = ParseColorError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Color256, ParseColorError>

Parses a string s to return a value of this type.

impl Hash for Color256

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 Color256

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Color256

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

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

const 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 PartialOrd for Color256

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Color256

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Copy for Color256

impl Eq for Color256

impl StructuralPartialEq for Color256