Skip to main content

ColorDepth

Enum ColorDepth 

Source
#[repr(u8)]
pub enum ColorDepth { Mono = 0, Ansi16 = 1, Ansi256 = 2, TrueColor = 3, }
Expand description

Maximum color fidelity the terminal may receive.

This is a single ordered capability rather than independent booleans so impossible states such as “truecolor but not 256-color” cannot exist.

Variants§

§

Mono = 0

Do not emit foreground or background color sequences.

§

Ansi16 = 1

Standard 16-color ANSI palette.

§

Ansi256 = 2

Extended 256-color ANSI palette.

§

TrueColor = 3

Full 24-bit RGB color.

Implementations§

Source§

impl ColorDepth

Source

pub fn detect() -> ColorDepth

Detect color depth using the canonical terminal capability detector.

Source

pub fn detect_from_env( no_color: Option<&str>, colorterm: Option<&str>, term: Option<&str>, ) -> ColorDepth

Detect color depth from explicit environment values.

NO_COLOR presence wins over every terminal signal. TERM=dumb, TERM=vt100, and a missing/empty TERM are monochrome. Direct-color TERM variants (*-direct[digits], *-truecolor, and *-24bit) receive truecolor. Plain xterm and other non-dumb terminals conservatively receive ANSI16.

Source

pub const fn as_str(self) -> &'static str

Stable identifier used in diagnostics and evidence logs.

Source

pub const fn supports_color(self) -> bool

Whether any color sequences may be emitted.

Source

pub const fn supports_256_colors(self) -> bool

Whether the terminal supports at least the 256-color palette.

Source

pub const fn supports_true_color(self) -> bool

Whether the terminal supports 24-bit RGB color.

Trait Implementations§

Source§

impl Clone for ColorDepth

Source§

fn clone(&self) -> ColorDepth

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ColorDepth

Source§

impl Debug for ColorDepth

Source§

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

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

impl Default for ColorDepth

Source§

fn default() -> ColorDepth

Returns the “default value” for a type. Read more
Source§

impl Display for ColorDepth

Source§

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

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

impl Eq for ColorDepth

Source§

impl Hash for ColorDepth

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 ColorDepth

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · 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 ColorDepth

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for ColorDepth

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · 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 (const: unstable) · 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 (const: unstable) · 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 (const: unstable) · 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 StructuralPartialEq for ColorDepth

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.