Struct EntryPoint 

pub struct EntryPoint {
    pub cmd: Option<ZebradCmd>,
    pub config: Option<PathBuf>,
    pub verbose: bool,
    filters: Vec<String>,
}

Toplevel entrypoint command.

Handles obtaining toplevel help as well as verbosity settings.

Fields

cmd: Option<ZebradCmd>

Subcommand to execute.

The command option will delegate option parsing to the command type, starting at the first free argument. Defaults to start.

config: Option<PathBuf>

Path to the configuration file

verbose: bool

Increase verbosity setting

filters: Vec<String>

Filter strings which override the config file and defaults

Implementations

impl EntryPoint

pub fn cmd(&self) -> &ZebradCmd

Borrow the command in the option

Panics

If cmd is None

pub fn default_cmd_as_str() -> &'static str

Returns a string that parses to the default subcommand

fn should_add_default_subcommand(&self) -> bool

Checks if the provided arguments include a subcommand

pub fn process_cli_args(args: Vec<OsString>) -> Result<Vec<OsString>>

Process command arguments and insert the default subcommand if no subcommand is provided.

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 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 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<ZebradConfig> for EntryPoint

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

Path to the command’s configuration file

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

Process the configuration after it has been loaded, potentially modifying it or returning an error if options are incompatible

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 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

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 112 bytes