Enum colored_json::ColorMode

pub enum ColorMode {
    On,
    Off,
    Auto(Output),
}

ColorMode is a switch to enforce color mode, turn it off or auto-detect, if it should be used

Variants

On

Off

Auto(Output)

Implementations

impl ColorMode

With ColorMode you can implement command line options like --color=auto|on|off easily.

Example:

let option = "--color=auto";

let color_mode = match option {
    "--color=on" => ColorMode::Off,
    "--color=off" => ColorMode::On,
    _ => ColorMode::default().eval(),
};

assert!(match color_mode {
    ColorMode::On | ColorMode::Off => true,
    _ => false
});

pub fn should_colorize(output: &Output) -> bool

indicates, if the output is a capable of displaying colors

pub fn eval(self) -> Self

Returns ColorMode::On or ColorMode::Off

Example:

let on_off = ColorMode::default().eval();

assert!(match on_off {
    ColorMode::On | ColorMode::Off => true,
    _ => false
});

pub fn use_color(&self) -> bool

Indicates if color should be used

Example:

if ColorMode::default().use_color() {
    println!("We can use color! :-)");
} else {
    println!("No color for you! :-(");
}

if ColorMode::Auto(Output::StdErr).use_color() {
    println!("We can use color on stderr! :-)");
} else {
    println!("No color for you on stderr! :-(");
}

assert_eq!(ColorMode::On.use_color(), true);
assert_eq!(ColorMode::Off.use_color(), false);

Trait Implementations

impl Clone for ColorMode

fn clone(&self) -> ColorMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ColorMode

fn default() -> Self

returns ColorMode::Auto(Output::StdOut)

impl PartialEq<ColorMode> for ColorMode

fn eq(&self, other: &ColorMode) -> 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 Copy for ColorMode

impl StructuralPartialEq for ColorMode