Enum clap::builder::styling::AnsiColor

#[repr(u8)]
pub enum AnsiColor {
    Black = 0,
    Red = 1,
    Green = 2,
    Yellow = 3,
    Blue = 4,
    Magenta = 5,
    Cyan = 6,
    White = 7,
    BrightBlack = 8,
    BrightRed = 9,
    BrightGreen = 10,
    BrightYellow = 11,
    BrightBlue = 12,
    BrightMagenta = 13,
    BrightCyan = 14,
    BrightWhite = 15,
}

Available 4-bit ANSI color palette codes

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

Variants

Black = 0

Black: #0 (foreground code 30, background code 40).

Red = 1

Red: #1 (foreground code 31, background code 41).

Green = 2

Green: #2 (foreground code 32, background code 42).

Yellow = 3

Yellow: #3 (foreground code 33, background code 43).

Blue = 4

Blue: #4 (foreground code 34, background code 44).

Magenta = 5

Magenta: #5 (foreground code 35, background code 45).

Cyan = 6

Cyan: #6 (foreground code 36, background code 46).

White = 7

White: #7 (foreground code 37, background code 47).

BrightBlack = 8

Bright black: #0 (foreground code 90, background code 100).

BrightRed = 9

Bright red: #1 (foreground code 91, background code 101).

BrightGreen = 10

Bright green: #2 (foreground code 92, background code 102).

BrightYellow = 11

Bright yellow: #3 (foreground code 93, background code 103).

BrightBlue = 12

Bright blue: #4 (foreground code 94, background code 104).

BrightMagenta = 13

Bright magenta: #5 (foreground code 95, background code 105).

BrightCyan = 14

Bright cyan: #6 (foreground code 96, background code 106).

BrightWhite = 15

Bright white: #7 (foreground code 97, background code 107).

Implementations

impl AnsiColor

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

pub fn bright(self, yes: bool) -> AnsiColor

Change the color to/from bright

pub fn is_bright(self) -> bool

Report whether the color is bright

Trait Implementations

impl Clone for AnsiColor

fn clone(&self) -> AnsiColor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnsiColor

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

Formats the value using the given formatter.

impl From<AnsiColor> for Ansi256Color

fn from(inner: AnsiColor) -> Ansi256Color

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 Hash for AnsiColor

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 AnsiColor

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

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

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

impl Eq for AnsiColor

impl StructuralPartialEq for AnsiColor