Enum ColorChoice 

pub enum ColorChoice {
    Never,
    Auto,
    Always,
}

Possible color choices for the output.

Clap interoperability

If the clap feature is enabled then ColorChoice can be converted to and from clap::ColorChoice. Moreover it implements clap::ValueEnum, hence can be used as

#[derive(clap::Parser)]
struct Cli {
    /// Coloring of the output
    #[clap(long, value_name = "WHEN", arg_enum, global = true)]
    color: Option<should_color::ColorChoice>,

    // Other arguments...
}

Variants

Never

The output will not be colorized.

Auto

The output will be colorized if the output device is a tty, i.e. when the output goes directly to a text screen or terminal emulator window.

Always

The output will be colorized.

Implementations

impl ColorChoice

pub fn for_stream(&self, stream: Stream) -> bool

Available on crate feature stream only.

Determine the color setting for a specific stream.

If the choice is ColorChoice::Never or ColorChoice::Always, the result will be false and true respectively.

If the choice is ColorChoice::Auto, then the answer depends on whether the stream is a TTY or not.

See the examples colored.rs and termcolor.rs for a demonstration of how to use this method.

Trait Implementations

impl Clone for ColorChoice

fn clone(&self) -> ColorChoice

Returns a duplicate 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

Formats the value using the given formatter.

impl From<ColorChoice> for ColorChoice

Available on crate feature clap only.

fn from(color_choice: ColorChoice) -> ColorChoice

Converts to this type from the input type.

impl From<ColorChoice> for ColorChoice

Available on crate feature clap only.

fn from(color_choice: ColorChoice) -> ColorChoice

Converts to this type from the input type.

impl Ord for ColorChoice

fn cmp(&self, other: &ColorChoice) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ColorChoice

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ColorChoice

fn partial_cmp(&self, other: &ColorChoice) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ValueEnum for ColorChoice

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

All possible argument values, in display order.

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

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