Enum Depth 

pub enum Depth {
    None,
    Ansi16,
    Ansi256,
    TrueColor,
}

How many colors a terminal shows. Ordered: a deeper terminal shows everything a shallower one does.

Variants

None

No color and no attributes: a pipe, a file, NO_COLOR.

Ansi16

The 16 basic colors, bold, underline: every color terminal.

Ansi256

The xterm 256-color palette: TERM=*-256color.

TrueColor

24-bit color: COLORTERM=truecolor.

Implementations

impl Depth

pub fn detect(is_terminal: bool) -> Depth

The depth for a stream that is (or is not) a terminal, from the environment:

• a non-empty NO_COLOR means none, and it wins over FORCE_COLOR;
• FORCE_COLOR=0 or false means none too;
• FORCE_COLOR (1–3, or empty/true for 1) is a minimum depth, not the depth: a terminal that can show more still does. CLICOLOR_FORCE (not 0) gives color even to a pipe;
• otherwise none for a pipe, CLICOLOR=0, TERM=dumb, or no TERM at all;
• then 24-bit for COLORTERM=truecolor/24bit, a TERM ending in direct or truecolor, or iTerm2; 256 for a TERM ending in 256/256color or Apple’s Terminal; else 16.

Under with_env the stream never counts as a terminal, so the answer depends only on the variables given.

Trait Implementations

impl Clone for Depth

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Depth

impl Debug for Depth

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

Formats the value using the given formatter.

impl Eq for Depth

impl Hash for Depth

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

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 Depth

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

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Depth

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Depth

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for Depth