Enum ColorChoice 

pub enum ColorChoice {
    Auto,
    Always,
    Never,
}

User preference for emitting ANSI color escape codes.

Variants

Auto

Automatically enable color if writing to a TTY and environment allows it.

Always

Always emit ANSI color codes, even when redirected or piped.

Never

Never emit ANSI color codes.

Implementations

impl ColorChoice

pub fn should_color(self, is_terminal: bool) -> bool

Determine whether color should be active given the terminal/TTY status of the output.

Respects:

• NO_COLOR (https://no-color.org)
• FORCE_COLOR (https://force-color.org)
• TERM=dumb
• Stream TTY status

pub fn detect_auto(is_terminal: bool) -> bool

Automatically detect whether color is supported for the current environment.

pub fn detect_with( is_terminal: bool, get_var: impl Fn(&str) -> Option<String>, ) -> bool

Internal helper that tests environment variables using a mockable lookup closure.

pub fn resolve_stdout(self) -> bool

Resolve whether stdout should currently display colors.

pub fn resolve_stderr(self) -> bool

Resolve whether stderr should currently display colors.

Trait Implementations

impl Clone for ColorChoice

fn clone(&self) -> ColorChoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ColorChoice

impl Debug for ColorChoice

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

Formats the value using the given formatter.

impl Default for ColorChoice

fn default() -> ColorChoice

Returns the “default value” for a type.

impl Eq for ColorChoice

impl PartialEq for ColorChoice

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ColorChoice