Enum ColorChoice 

#[non_exhaustive]
pub enum ColorChoice {
    Auto,
    Always,
    Never,
}

Available on crate features human and std only.

When to colour HumanFormat output.

Resolved once, when a sink is built, into a plain on/off setting for HumanFormat::color.

Examples

use log_io::format::{ColorChoice, HumanFormat};

let fmt = HumanFormat::new().color(ColorChoice::Auto.enabled_for_stderr());
assert!(ColorChoice::Always.resolve(false));
assert!(!ColorChoice::Never.resolve(true));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Auto

Colour when the destination is a terminal, honouring the conventional environment variables:

• NO_COLOR set to a non-empty value disables colour;
• CLICOLOR_FORCE set to a non-empty value other than 0 enables colour even when not a terminal;
• TERM=dumb disables colour.

On Windows, colour is only enabled automatically inside terminals known to interpret ANSI sequences without extra setup (Windows Terminal, ConEmu, or any environment that sets TERM, such as Git Bash or MSYS2). The classic console host needs the virtual-terminal mode switched on through the Windows API, which this crate does not do because it forbids unsafe code; use ColorChoice::Always if your program enables that mode itself.

Always

Always colour.

Never

Never colour.

Implementations

impl ColorChoice

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

Resolve against an explicit “is the destination a terminal” answer and the process environment.

pub fn enabled_for_stdout(self) -> bool

Resolve for the process’s standard output.

pub fn enabled_for_stderr(self) -> bool

Resolve for the process’s standard error.

Trait Implementations

impl Clone for ColorChoice

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 ColorChoice

impl Debug for ColorChoice

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

Formats the value using the given formatter.

impl Default for ColorChoice

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ColorChoice

impl PartialEq for ColorChoice

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ColorChoice