Struct ockam_command::GlobalArgs

pub struct GlobalArgs {
    pub quiet: bool,
    pub verbose: u8,
    pub no_color: bool,
    pub no_input: bool,
    pub output_format: Option<OutputFormatArg>,
    pub jq_query: Option<String>,
    pub pretty: bool,
    pub test_argument_parser: bool,
    /* private fields */
}

Those arguments are common to all commands

Fields

quiet: bool

Do not print any log messages to stderr and disable confirmation prompts. This is useful for scripting and automation, where you don’t want the process to block on stdin.

verbose: u8

Increase verbosity of trace messages

no_color: bool

Disable colors in output

no_input: bool

Disable tty functionality, like interactive prompts.

output_format: Option<OutputFormatArg>

Specifies the output format of the command. Defaults to ‘plain’ if not explicitly set. The ‘plain’ format is a piece of plain text, the content of which may change based on whether the stdout is a tty or not. For instance, if stdout is redirected to a file, the output is usually an identifier that can be used as input for other commands. If stdout is a tty, the output will contain human-readable information about the command execution. The ‘json’ format can be customized witht he --jq and --pretty options.

jq_query: Option<String>

jq query to apply to the JSON output of the command

pretty: bool

Pretty print the JSON output of the command

test_argument_parser: bool

Implementations

impl GlobalArgs

pub fn set_quiet(&self) -> Self

pub fn output_format(&self) -> Result<OutputFormat>

Trait Implementations

impl Args for GlobalArgs

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.

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

Append to Command so it can update self.

impl Clone for GlobalArgs

fn clone(&self) -> GlobalArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalArgs

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

Formats the value using the given formatter.

impl Default for GlobalArgs

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for GlobalArgs

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.