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

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§

source§

impl ColorChoice

source

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

Returns true if we should attempt to write colored output.

source

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

Trait Implementations§

source§

impl Clone for ColorChoice

source§

fn clone(&self) -> ColorChoice

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ColorChoice

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for ColorChoice

The default is Auto.

source§

fn default() -> ColorChoice

Returns the “default value” for a type. Read more
source§

impl FromStr for ColorChoice

§

type Err = ColorChoiceParseError

The associated error which can be returned from parsing.
source§

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

Parses a string s to return a value of this type. Read more
source§

impl PartialEq<ColorChoice> for ColorChoice

source§

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

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

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.
source§

impl Copy for ColorChoice

source§

impl Eq for ColorChoice

source§

impl StructuralEq for ColorChoice

source§

impl StructuralPartialEq for ColorChoice

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.