Enum termcolor::ColorChoice

pub enum ColorChoice {
    Always,
    AlwaysAnsi,
    Auto,
    Never,
}

ColorChoice represents the color preferences of an end user.

The Default implementation for this type will select Auto, which tries to do the right thing based on the current environment.

The FromStr implementation for this type converts a lowercase kebab-case string of the variant name to the corresponding variant. Any other string results in an error.

Variants

Always

Try very hard to emit colors. This includes emitting ANSI colors on Windows if the console API is unavailable.

AlwaysAnsi

AlwaysAnsi is like Always, except it never tries to use anything other than emitting ANSI color codes.

Auto

Try to use colors, but don’t force the issue. If the console isn’t available on Windows, or if TERM=dumb, or if NO_COLOR is defined, for example, then don’t use colors.

Never

Never emit colors.

Implementations

impl ColorChoice

pub(crate) fn should_attempt_color(&self) -> bool

Returns true if we should attempt to write colored output.

pub(crate) fn env_allows_color(&self) -> bool

Trait Implementations

impl Clone for ColorChoice

fn clone(&self) -> ColorChoice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColorChoice

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

Formats the value using the given formatter.

impl Default for ColorChoice

The default is Auto.

fn default() -> ColorChoice

Returns the “default value” for a type.

impl FromStr for ColorChoice

type Err = ColorChoiceParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ColorChoice, ColorChoiceParseError>

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

impl PartialEq for ColorChoice

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for ColorChoice

impl Eq for ColorChoice

impl StructuralPartialEq for ColorChoice