clap::builder::styling

Enum AnsiColor

Source
#[repr(u8)]
pub enum AnsiColor {
Show 16 variants 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,
}
Expand description

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§

Source§

impl AnsiColor

Source

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

Create a Style with this as the foreground

Source

pub const fn on_default(self) -> Style

Create a Style with this as the foreground

Source

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

Render the ANSI code for a foreground color

Source

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

Render the ANSI code for a background color

Source

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

Change the color to/from bright

Source

pub fn is_bright(self) -> bool

Report whether the color is bright

Trait Implementations§

Source§

impl Clone for AnsiColor

Source§

fn clone(&self) -> AnsiColor

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AnsiColor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<AnsiColor> for Ansi256Color

Source§

fn from(inner: AnsiColor) -> Ansi256Color

Converts to this type from the input type.
Source§

impl From<AnsiColor> for Color

Source§

fn from(inner: AnsiColor) -> Color

Converts to this type from the input type.
Source§

impl Hash for AnsiColor

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for AnsiColor

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for AnsiColor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for AnsiColor

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl Copy for AnsiColor

Source§

impl Eq for AnsiColor

Source§

impl StructuralPartialEq for AnsiColor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1 byte

Size for each variant:

  • Black: 0 bytes
  • Red: 0 bytes
  • Green: 0 bytes
  • Yellow: 0 bytes
  • Blue: 0 bytes
  • Magenta: 0 bytes
  • Cyan: 0 bytes
  • White: 0 bytes
  • BrightBlack: 0 bytes
  • BrightRed: 0 bytes
  • BrightGreen: 0 bytes
  • BrightYellow: 0 bytes
  • BrightBlue: 0 bytes
  • BrightMagenta: 0 bytes
  • BrightCyan: 0 bytes
  • BrightWhite: 0 bytes