Struct Args 

pub struct Args {
    pub results_dir: PathBuf,
    pub output: Option<PathBuf>,
    pub suite: String,
    pub commit: Option<String>,
    pub reference_dir: Option<PathBuf>,
    pub candidate_dir: Option<PathBuf>,
    pub executables: Option<PathBuf>,
    pub cargo_log: Option<PathBuf>,
    pub source_dir: Option<PathBuf>,
    pub minimum_tolerance_percent: f64,
    pub command: Option<Command>,
}

CLI configuration arguments for parsing benchmarks.

Fields

results_dir: PathBuf

Directory containing benchmark .txt output files.

output: Option<PathBuf>

Output JSON summary file path (defaults to <results_dir>/broker-benchmarks.json).

suite: String

Suite identifier for the benchmark summary.

commit: Option<String>

Git commit SHA (defaults to GITHUB_SHA env var or "unknown").

reference_dir: Option<PathBuf>

Directory of repeated reference summary JSON files to compare.

candidate_dir: Option<PathBuf>

Directory of repeated candidate summary JSON files to compare.

executables: Option<PathBuf>

The executable manifest this pass’s side was prebuilt into. With it, the summary records which executables the pass ran, and parsing fails unless they are the manifest’s, unchanged.

cargo_log: Option<PathBuf>

Cargo’s standard error from this pass, whose Running lines name the executables it ran.

source_dir: Option<PathBuf>

The directory Cargo ran in, against which relative Running paths resolve (defaults to the current directory).

minimum_tolerance_percent: f64

Minimum allowed slowdown percentage for comparison mode.

command: Option<Command>

The broker performance lane; without one, the criterion lane runs.

Trait Implementations

impl Args for Args

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 Clone for Args

fn clone(&self) -> Args

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Args

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 Args

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

Formats the value using the given formatter.

impl FromArgMatches for Args

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 Args

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.