Struct ColorArg

pub struct ColorArg(pub ColorChoice);

A command line argument that configures the coloring of the output.

This can be used with command line argument parsers like clap or structopt.

Example

use codespan_reporting::term::termcolor::StandardStream;
use codespan_reporting::term::ColorArg;
use structopt::StructOpt;

#[derive(Debug, StructOpt)]
#[structopt(name = "groovey-app")]
pub struct Opts {
    /// Configure coloring of output
    #[structopt(
        long = "color",
        default_value = "auto",
        possible_values = ColorArg::VARIANTS,
        case_insensitive = true,
    )]
    pub color: ColorArg,
}

let opts = Opts::from_args();
let writer = StandardStream::stderr(opts.color.into());

Tuple Fields

0: ColorChoice

Implementations

impl ColorArg

pub const VARIANTS: &'static [&'static str] = _

Allowed values the argument.

This is useful for generating documentation via clap or structopt’s possible_values configuration.

Trait Implementations

impl Clone for ColorArg

fn clone(&self) -> ColorArg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColorArg

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

Formats the value using the given formatter.

impl FromStr for ColorArg

type Err = &'static str

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<ColorArg, &'static str>

Parses a string s to return a value of this type.

impl Into<ColorChoice> for ColorArg

fn into(self) -> ColorChoice

Converts this type into the (usually inferred) input type.

impl PartialEq for ColorArg

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

impl Eq for ColorArg

impl StructuralPartialEq for ColorArg