Enum clap::ColorChoice

pub enum ColorChoice {
    Auto,
    Always,
    Never,
}

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();

Implementations

impl ColorChoice

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

Report all possible_values

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<(), Error>

Formats the value using the given formatter.

impl Default for ColorChoice

fn default() -> ColorChoice

Returns the “default value” for a type.

impl Display for ColorChoice

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

Formats the value using the given formatter.

impl FromStr for ColorChoice

type Err = String

The associated error which can be returned from parsing.

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

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 ValueEnum for ColorChoice

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

All possible argument values, in display order.

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

The canonical argument value.

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

Parse an argument into Self.

impl Copy for ColorChoice

impl Eq for ColorChoice

impl StructuralEq for ColorChoice

impl StructuralPartialEq for ColorChoice