Struct CliArgs 

pub struct CliArgs {
    pub verbose: u8,
    pub output_format: Option<OutputFormat>,
    pub output_file: Option<String>,
    pub sources: Vec<Source>,
    pub overrides: Vec<ConfigOverride>,
    pub config_file: Option<PathBuf>,
    pub command: ProfilerCommand,
}

joule-profiler: measure program energy consumption

Fields

verbose: u8

Verbosity (-v, -vv, -vvv)

output_format: Option<OutputFormat>

Output format to export the results in. (e.g., terminal, json, csv)

output_file: Option<String>

Output file for CSV/JSON. (else data<TIMESTAMP>.csv/json)

sources: Vec<Source>

Sources activation list. All sources must be separated with a comma (e.g., “rapl,nvml”).

overrides: Vec<ConfigOverride>

Override a configuration key, repeatable. (e.g., -D profiler.rapl_backend=powercap)

KEY is the dotted path of the key in the configuration file, so any key a configuration file can set is settable here: -D profiler.output_format=json -D sources.rapl.sockets_spec=[0,1] -D sources.cgroup.create_cgroup=false

VALUE is read as TOML, falling back to a plain string, so durations, regexes and paths need no quoting. Overrides are applied on top of the –config file, and configuring a source enables it.

config_file: Option<PathBuf>

TOML configuration file. Every key it sets can also be set with -D.

command: ProfilerCommand

The command to execute.

Implementations

impl CliArgs

pub fn from_args() -> Self

pub fn validate(&self) -> Result<()>

Trait Implementations

impl Args for CliArgs

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 CommandFactory for CliArgs

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 CliArgs

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

Formats the value using the given formatter.

impl FromArgMatches for CliArgs

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 CliArgs

fn parse() -> Self

Parse from std::env::args_os(), 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 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 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.