Enum clap_builder::builder::styling::Color

pub enum Color {
    Ansi(AnsiColor),
    Ansi256(Ansi256Color),
    Rgb(RgbColor),
}

Any ANSI color code scheme

Variants

Ansi(AnsiColor)

Available 4-bit ANSI color palette codes

The user’s terminal defines the meaning of the each palette code.

Ansi256(Ansi256Color)

256 (8-bit) color support

• 0..16 are AnsiColor palette codes
• 0..232 map to RgbColor color values
• 232.. map to RgbColor gray-scale values

Rgb(RgbColor)

24-bit ANSI RGB color codes

Implementations

impl Color

pub fn on(self, background: impl Into<Color>) -> Style

Create a Style with this as the foreground

pub const fn on_default(self) -> Style

Create a Style with this as the foreground

pub fn render_fg(self) -> impl Display + Copy

Render the ANSI code for a foreground color

pub fn render_bg(self) -> impl Display + Copy

Render the ANSI code for a background color

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a copy 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<(), Error>

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<Ansi256Color> for Color

fn from(inner: Ansi256Color) -> Color

Converts to this type from the input type.

impl From<AnsiColor> for Color

fn from(inner: AnsiColor) -> Color

Converts to this type from the input type.

impl From<RgbColor> for Color

fn from(inner: RgbColor) -> Color

Converts to this type from the input type.

impl From<u8> for Color

fn from(inner: u8) -> Color

Converts to this type from the input type.

impl Hash for Color

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Color

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Color

impl Eq for Color

impl StructuralPartialEq for Color