Struct CliArgs 

pub struct CliArgs {
    pub verbose: u8,
    pub rapl_path: Option<String>,
    pub sockets: Option<String>,
    pub json: bool,
    pub csv: bool,
    pub output_file: Option<String>,
    pub gpu: bool,
    pub perf: bool,
    pub rapl_backend: RaplBackend,
    pub command: ProfilerCommand,
}

joule-profiler: measure program energy consumption

Fields

verbose: u8

Verbosity (-v, -vv, -vvv)

rapl_path: Option<String>

Override the base path used to read Intel RAPL counters.

By default, the profiler reads from: /sys/devices/virtual/powercap/intel-rapl

If not provided, the profiler uses (by priority):

1. $JOULE_PROFILER_RAPL_PATH (if set)
2. /sys/devices/virtual/powercap/intel-rapl

sockets: Option<String>

Sockets to measure (e.g. 0 or 0,1)

json: bool

Export results as JSON instead of pretty terminal output

csv: bool

Export results as CSV (semicolon-separated values)

output_file: Option<String>

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

gpu: bool

GPU support

perf: bool

perf_event counters support

rapl_backend: RaplBackend

Choose RAPL backend between powercap or perf

command: ProfilerCommand

The command to execute

Implementations

impl CliArgs

pub fn from_args() -> Self

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 From<CliArgs> for Config

fn from(cli_args: CliArgs) -> Self

Converts to this type from the input type.

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.