Enum clap_builder::builder::styling::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 + PartialOrd,

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

impl PartialEq for AnsiColor

source§

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

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

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.
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

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

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

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

This method 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: Copy,

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> CloneToUninit for T
where T: Clone,

source§

default 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,

§

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

§

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

§

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.