Struct CommonArgs 

pub struct CommonArgs {
    pub config: Option<String>,
    pub log_level: String,
    pub log_format: String,
    pub metrics_addr: String,
    pub verbose: bool,
    pub quiet: bool,
}

Available on crate feature cli only.

Standard CLI arguments for DFE services.

Provides the 80% of flags that every service needs: config path, log level/format, metrics address, verbose/quiet modes.

Embed in your Clap parser with #[command(flatten)].

Fields

config: Option<String>

Path to configuration file.

log_level: String

Log level (trace, debug, info, warn, error).

log_format: String

Log output format (json, text, auto).

metrics_addr: String

Metrics server bind address.

verbose: bool

Enable verbose output (sets log level to debug).

quiet: bool

Suppress all output except errors.

Implementations

impl CommonArgs

pub fn effective_log_level(&self) -> &str

Resolve the effective log level, accounting for –verbose and –quiet flags.

pub fn to_logger_options(&self) -> Result<LoggerOptions, CliError>

Available on crate feature logger only.

Convert to LoggerOptions for use with logger::setup().

Parses the log level and format strings into their typed equivalents.

Errors

Returns CliError::InvalidArgument if the log level or format is invalid.

pub fn to_config_options(&self, env_prefix: &str) -> ConfigOptions

Available on crate feature config only.

Convert to ConfigOptions for use with config::setup().

Trait Implementations

impl Args for CommonArgs

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 CommonArgs

fn clone(&self) -> CommonArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommonArgs

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

Formats the value using the given formatter.

impl FromArgMatches for CommonArgs

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.