Enum ColorDepth 

pub enum ColorDepth {
    Mono,
    Ansi16,
    Ansi256,
    TrueColor,
}

How many colours the output can carry.

The frontier glow is a gradient, so it is the part of the design that suffers most on a limited terminal. Rather than emit 24-bit escapes everywhere and let the terminal do something arbitrary, the palette is mapped down explicitly.

Variants

Mono

No colour at all. Chosen when NO_COLOR is set or TERM=dumb.

Ansi16

The 16 ANSI colours.

Ansi256

The 256-colour cube. The default when the terminal does not say otherwise.

TrueColor

24-bit colour, the full palette.

Implementations

impl ColorDepth

pub fn detect() -> Self

What the current terminal advertises.

Honours NO_COLOR, then COLORTERM, then TERM, and treats Windows Terminal as truecolor. Falls back to Ansi256, which is near-universal and keeps the gradient readable.

pub fn is_color(self) -> bool

True when anything at all should be coloured.

pub fn quantize(self, (r, g, b): (u8, u8, u8)) -> Option<Fg>

Map an RGB triple onto the closest colour this depth can show.

Trait Implementations

impl Clone for ColorDepth

fn clone(&self) -> ColorDepth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ColorDepth

impl Debug for ColorDepth

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

Formats the value using the given formatter.

impl Default for ColorDepth

fn default() -> ColorDepth

Returns the “default value” for a type.

impl Eq for ColorDepth

impl PartialEq for ColorDepth

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ColorDepth