Enum Color

pub enum Color {
    Default,
    Color256(Color256),
    Rgb(RgbColor),
}

An enum of the different color types

Variants

Default

The terminal’s default foreground or background color

Color256(Color256)

Rgb(RgbColor)

Implementations

impl Color

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 Color

fn clone(&self) -> Color

Returns a duplicate of the value.

const 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() -> Color

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Color

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 Color

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

Formats the value using the given formatter.

impl From<(u8, u8, u8)> for Color

fn from(value: (u8, u8, u8)) -> Color

Converts to this type from the input type.

impl From<Color> for Color

Available on crate feature anstyle only.

fn from(value: Color) -> Color

Convert an anstyle::Color to a Color

impl From<Color> for Color

Available on crate feature crossterm only.

fn from(value: Color) -> Color

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

impl From<Color> for Color

Available on crate feature crossterm only.

fn from(value: Color) -> Color

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

impl From<Color> for Color

Available on crate feature ratatui only.

fn from(value: Color) -> Color

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

impl From<Color> for Color

Available on crate feature ratatui only.

fn from(value: Color) -> Color

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

impl From<Color256> for Color

fn from(value: Color256) -> Color

Converts to this type from the input type.

impl From<RgbColor> for Color

fn from(value: RgbColor) -> Color

Converts to this type from the input type.

impl From<u8> for Color

fn from(value: u8) -> Color

Converts to this type from the input type.

impl FromStr for Color

type Err = ParseColorError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this 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) -> 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 Color

fn eq(&self, other: &Color) -> 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 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

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 Color

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

Available on crate feature anstyle only.

fn try_from(value: Color) -> Result<Color, ConversionError>

Convert a Color to an anstyle::Color

Errors

Returns Err if value is Color::Default, which is not representable by anstyle::Color

type Error = ConversionError

The type returned in the event of a conversion error.

impl Copy for Color

impl Eq for Color

impl StructuralPartialEq for Color