Struct pace_rs::commands::EntryPoint

pub struct EntryPoint {
    pub verbose: bool,
    pub config: Option<PathBuf>,
    pub activity_log_file: Option<PathBuf>,
    pub home: Option<PathBuf>,
    /* private fields */
}

Entry point for the application. It needs to be a struct to allow using subcommands!

Fields

verbose: bool

Enable verbose logging

config: Option<PathBuf>

Use the specified config file

activity_log_file: Option<PathBuf>

Use the specified activity log file

home: Option<PathBuf>

Pace Home Directory

Trait Implementations

impl Args for EntryPoint

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.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

impl Command for EntryPoint

fn name() -> &'static str

Name of this program as a string

fn description() -> &'static str

Description of this program

fn authors() -> &'static str

Authors of this program

fn parse_args<T, I>(into_args: I) -> Self

where Self: Parser, I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse command-line arguments from an iterator

fn parse_env_args() -> Self

where Self: Parser,

Parse command-line arguments from the environment

impl CommandFactory for EntryPoint

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 Configurable<PaceConfig> for EntryPoint

This trait allows you to define how application configuration is loaded.

fn config_path(&self) -> Option<PathBuf>

Location of the configuration file

fn process_config( &self, config: PaceConfig ) -> Result<PaceConfig, FrameworkError>

Apply changes to the config after it’s been loaded, e.g. overriding values in a config file using command-line options.

This can be safely deleted if you don’t want to override config settings from command-line options.

impl Debug for EntryPoint

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

Formats the value using the given formatter.

impl FromArgMatches for EntryPoint

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 Override<PaceConfig> for EntryPoint

fn override_config( &self, config: PaceConfig ) -> Result<PaceConfig, FrameworkError>

Process the given command line options, overriding settings from a configuration file using explicit flags taken from command-line arguments.

impl Parser for EntryPoint

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.

impl Runnable for EntryPoint

fn run(&self)

Run this Runnable