Enum ColorChoice 

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

A user’s requested color policy, before environment/TTY resolution.

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

Enable color only when writing to a terminal and NO_COLOR is unset.

Always

Force color on (still overridden by NO_COLOR).

Never

Force color off.

Implementations

impl ColorChoice

pub fn from_name(name: &str) -> Option<Self>

Parse a choice from its lowercase name (auto/always/never).

Returns None for any other value so the caller can raise its own typed usage error naming the accepted values.

pub const fn as_str(self) -> &'static str

The canonical lowercase name of this choice.

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ColorChoice