Enum ColorChoice 

pub enum ColorChoice {
    Auto,
    Always,
    Never,
}

How to resolve whether to emit ANSI color codes. Parsed from --color=<auto|always|never>.

On Auto, ColorChoice::resolve consults the CLICOLOR_FORCE env var (which anstream does NOT check on its own) and pre-resolves to Always when it’s set to anything other than "0". The resulting choice is then handed to anstream::AutoStream, which honors NO_COLOR and the TTY check on the remaining Auto cases.

Always / Never are explicit user overrides and bypass the env-var resolution entirely — useful when piping into a pager that understands ANSI, or when capturing output for a snapshot test.

Precedence summary:

--color	env	result
always	(any)	colors on
never	(any)	colors off
auto	CLICOLOR_FORCE=1	colors on
auto	NO_COLOR=… (any value)	colors off
auto	TTY	colors on
auto	non-TTY	colors off

CLICOLOR_FORCE=0 (or unset) is treated as “no force”; only 1 (or any non-"0" value) forces colors on.

Variants

Auto

Always

Never

Implementations

impl ColorChoice

pub fn resolve(self) -> Self

Pre-resolve Auto against the CLICOLOR_FORCE env var before handing off to anstream. Auto + CLICOLOR_FORCE → Always; everything else returns self unchanged.

anstream::ColorChoice::Auto already honors NO_COLOR and the TTY check, so we don’t intercept those — the only env-var contract anstream doesn’t cover is CLICOLOR_FORCE, which this method adds.

pub fn to_anstream(self) -> ColorChoice

Map to anstream’s own enum so AutoStream::new accepts it directly. Callers should normally call ColorChoice::resolve first to pre-apply the CLICOLOR_FORCE precedence.

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

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 FromStr for ColorChoice

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for ColorChoice

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ColorChoice