Skip to main content

## ColorChoice

# Enum 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`.

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

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

#### §Examples

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

## Implementations§

Source§

### impl ColorChoice

Source

#### pub fn possible_values() -> impl Iterator<Item = PossibleValue>

Report all `possible_values`

## Trait Implementations§

Source§

### impl Clone for ColorChoice

Source§

#### fn clone(&self) -> ColorChoice

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Copy for ColorChoice

Source§

### impl Debug for ColorChoice

Source§

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

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

### impl Default for ColorChoice

Source§

#### fn default() -> ColorChoice

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

### impl Display for ColorChoice

Source§

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

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

### impl Eq for ColorChoice

Source§

### impl FromStr for ColorChoice

Source§

#### type Err = String

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

#### fn from_str(s: &str) -> Result<ColorChoice, <ColorChoice as FromStr>::Err>

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

### impl PartialEq for ColorChoice

Source§

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

Equality operator `==`. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator `!=`. Read more
Source§

### impl StructuralPartialEq for ColorChoice

Source§

### impl ValueEnum for ColorChoice

Source§

#### fn value_variants<'a>() -> &'a [ColorChoice]

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`.

## Auto Trait Implementations§

§

### impl Freeze for ColorChoice

§

### impl RefUnwindSafe for ColorChoice

§

### impl Send for ColorChoice

§

### impl Sync for ColorChoice

§

### impl Unpin for ColorChoice

§

### impl UnsafeUnpin 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,

Source§

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

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. 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 T
where 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 T
where T: Clone,

Source§

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

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

Source§

#### 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 T
where U: TryFrom<T>,

Source§

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