Struct codespan_reporting::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

extern crate codespan_reporting;
#[macro_use]
extern crate structopt;

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

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

fn main() {
    let opts = Opts::from_args();
    let writer = StandardStream::stderr(opts.color.into());
}

Methods

impl ColorArg

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

VARIANTS: &'static [&'static str] = &["auto", "always", "ansi", "never"]

Allowed values the argument

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

Trait Implementations

impl Copy for ColorArg

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, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for ColorArg

fn eq(&self, __arg_0: &ColorArg) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &ColorArg) -> bool

This method tests for !=.

impl Eq for ColorArg

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

Performs the conversion.