Struct Flags 

pub struct Flags {
    pub verbose: u8,
    pub quiet: u8,
    pub color: Option<Color>,
    pub yes: bool,
    pub non_interactive: u8,
    pub interactive: u8,
}

Available on crate features cli and print only.

Common flags for cu::cli

Fields

verbose: u8

Verbose. More -v makes it more verbose (opposite of –quiet)

quiet: u8

Quiet. More -q makes it more quiet (opposite of –verbose)

color: Option<Color>

Set the color mode for this program. May affect subprocesses spawned.

yes: bool

Available on crate feature prompt only.

Automatically answer ‘yes’ to all yes/no prompts

non_interactive: u8

Available on crate feature prompt only.

Make all prompts fail with an error. (Cancels with one –interactive)

interactive: u8

Available on crate feature prompt only.

Allow interactivity. Cancels with one –non-interactive

Implementations

impl Flags

pub unsafe fn apply(&self, log_config: Arc<dyn LogConfig + Send + Sync>)

Apply the CLI Flags

Safety

This is unsafe because it modifies environment variables. The cu::cli macro generates safe call to this when the program only has the main thread.

pub fn print_level(&self) -> Print

pub fn merge(&mut self, other: &Self)

Merge other into self. Options in other will be applied on top of self (equivalent to specifying self then specify other

Trait Implementations

impl Args for Flags

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 AsRef<Flags> for Flags

fn as_ref(&self) -> &Flags

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Flags

fn clone(&self) -> Flags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Flags

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 Flags

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

Formats the value using the given formatter.

impl Default for Flags

fn default() -> Flags

Returns the “default value” for a type.

impl FromArgMatches for Flags

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 Flags

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 Flags

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Flags