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 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 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<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into 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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Enum clap::ColorChoice

Variants

Auto

Always

Never

Trait Implementations

impl Clone for ColorChoice

fn clone(&self) -> ColorChoice

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

impl Debug for ColorChoice

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

impl Default for ColorChoice

fn default() -> Self

impl PartialEq<ColorChoice> for ColorChoice

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

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

impl Copy for ColorChoice

impl Eq for ColorChoice

impl StructuralEq for ColorChoice

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

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

`Auto`

`Always`

`Never`

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

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

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

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

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

impl<T> ToOwned for T where
T: Clone,

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

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