Struct OutputArgs 

#[non_exhaustive]
pub struct OutputArgs {
    pub format: OutputFormat,
    pub quiet: bool,
    /* private fields */
}

Available on crate feature cli only.

Output flags for the root parser: format, colour, and quiet. Flatten it with #[command(flatten)].

The flags are global, so a subcommand accepts them too. Self::view builds the View for the parsed flags. A CLI that already uses -c flattens ColorLong plus FormatArgs instead.

The colour flags are private, so Self::color is their only reader and --no-color is never skipped. A flag can join the struct in a minor release.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

format: OutputFormat

Output representation.

quiet: bool

Suppress successful pretty output.

Implementations

impl OutputArgs

pub fn color(&self) -> ColorMode

The colour mode in force: ColorMode::Never when --no-color is set, otherwise the --color value.

pub fn view(&self) -> View

Available on crate feature view only.

Build the View for these flags: the format, the quiet setting, and the colour mode in force.

Trait Implementations

impl Args for OutputArgs

fn group_id() -> Option<Id>

Report the 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 OutputArgs

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputArgs

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

Formats the value using the given formatter.

impl Default for OutputArgs

fn default() -> Self

Returns the “default value” for a type.

impl Eq for OutputArgs

impl FromArgMatches for OutputArgs

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 PartialEq for OutputArgs

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OutputArgs