Struct EconomicsExplainArgs 

pub struct EconomicsExplainArgs {
    pub repo: RepoArgs,
    pub format: OutputFormat,
    pub metric: String,
}

majordomus economics explain. The metric is a required positional identifier, spelled as the summary lists it; one the methodology does not declare is refused as not found, with the declared metrics named, rather than answered with an empty explanation.

use clap::Parser;
use majordomus_cli::cli::{
    Cli, Command, EconomicsCommand, EconomicsExplainArgs, OutputFormat,
};

fn explain_of(argv: &[&str]) -> EconomicsExplainArgs {
    let cli = Cli::try_parse_from(argv.iter().copied()).unwrap();
    let Command::Economics(args) = cli.command else { panic!("economics") };
    let EconomicsCommand::Explain(explain) = args.command else { panic!("explain") };
    explain
}

let e = explain_of(&["majordomus", "economics", "explain", "effective_token_reduction"]);
assert_eq!(e.metric, "effective_token_reduction");
assert_eq!(e.format, OutputFormat::Text);
// there is no default metric to explain
assert!(Cli::try_parse_from(["majordomus", "economics", "explain"]).is_err());

Fields

repo: RepoArgs

Where and how the repository is read.

format: OutputFormat

Output shape

metric: String

The metric, e.g. effective_token_reduction

Trait Implementations

impl Args for EconomicsExplainArgs

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 Debug for EconomicsExplainArgs

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

Formats the value using the given formatter.

impl FromArgMatches for EconomicsExplainArgs

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.