# Enum clap::ColorChoice

source · [−]

    pub enum ColorChoice {
        Auto,
        Always,
        Never,
    }

Expand description

Represents the color preferences for program output

## Variants

### `Auto`

Enables colored output only when the output is going to a terminal or TTY.

NOTE: This is the default behavior of `clap`.

#### Platform Specific

This setting only applies to Unix, Linux, and macOS (i.e. non-Windows platforms).

#### Examples

    Command::new("myprog")
       .color(ColorChoice::Auto)
       .get_matches();

### `Always`

Enables colored output regardless of whether or not the output is going to a terminal/TTY.

#### Platform Specific

This setting only applies to Unix, Linux, and macOS (i.e. non-Windows platforms).

#### Examples

    Command::new("myprog")
       .color(ColorChoice::Always)
       .get_matches();

### `Never`

Disables colored output no matter if the output is going to a terminal/TTY, or not.

#### Platform Specific

This setting only applies to Unix, Linux, and macOS (i.e. non-Windows platforms)

#### Examples

    Command::new("myprog")
       .color(ColorChoice::Never)
       .get_matches();

## 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

source

#### fn default() -> Self

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

source

### impl Display for ColorChoice

source

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

Formats the value using the given formatter. Read more

source

### impl FromStr for ColorChoice

#### type Err = String

The associated error which can be returned from parsing.

source

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

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 `==`. Read more

1.0.0 · source

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

This method tests for `!=`.

source

### impl ValueEnum for ColorChoice

source

#### fn value_variants<'a>() -> &'a [Self]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

All possible argument values, in display order.

source

#### fn to_possible_value(&self) -> Option<PossibleValue>

The canonical argument value. Read more

source

#### fn from_str(input: &str, ignore_case: bool) -> Result<Self, String>

Parse an argument into `Self`.

source

### impl Copy for ColorChoice

source

### impl Eq for ColorChoice

source

### impl StructuralEq for ColorChoice

source

### impl StructuralPartialEq for ColorChoice

## Auto Trait Implementations

### impl RefUnwindSafe for ColorChoice

### impl Send for ColorChoice

### impl Sync for ColorChoice

### impl Unpin for ColorChoice

### impl UnwindSafe for ColorChoice

## Blanket Implementations

source

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

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · 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 T where
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> ToString for T where
T: Display + ?Sized,

source

#### default fn to_string(&self) -> String

Converts the given value to a `String`. Read more

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.