Struct Output

pub struct Output {
    pub verbose: u8,
    pub quiet: bool,
    pub log_format: LogFormat,
    pub log_events: LogEvents,
    pub color: ColorChoice,
}

Control the output generated by the CLI.

Fields

verbose: u8

Generate verbose output (repeat for more verbosity)

quiet: bool

Do not print progress messages.

log_format: LogFormat

The format to use when generating logs.

log_events: LogEvents

Which span events to log.

color: ColorChoice

When to display colored output.

Implementations

impl Output

pub fn is_verbose(&self) -> bool

Has the --verbose flag been set?

pub fn is_quiet_or_no_tty(&self) -> bool

Returns true if either the --quiet flag is set or stderr is not a TTY.

pub fn initialize_logging(&self)

Initialize logging based on the $RUST_LOG environment variable and command-line flags.

fn log_filter(&self) -> EnvFilter

fn should_emit_colors(&self) -> bool

Check whether we should emit ANSI escape codes for log formatting.

The tracing-subscriber crate doesn’t have native support for “–color=always|never|auto”, so we implement a poor man’s version.

For more, see https://github.com/tokio-rs/tracing/issues/2388

pub fn draw_target(&self) -> ProgressDrawTarget

Get the draw target to be used with the indicatif crate.

Progress indicators won’t draw anything if the user passed the --quiet flag.

Trait Implementations

impl Args for Output

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for Output

fn clone(&self) -> Output

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Output

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for Output

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

Formats the value using the given formatter.

impl Default for Output

fn default() -> Output

Returns the “default value” for a type.

impl FromArgMatches for Output

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Output

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl PartialEq for Output

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