Struct abscissa::EntryPoint

pub struct EntryPoint<Cmd: Runnable + Command> {
    pub config: Option<PathBuf>,
    pub help: bool,
    pub verbose: bool,
    pub command: Option<Cmd>,
}

Toplevel entrypoint command.

Handles obtaining toplevel help as well as verbosity settings.

Fields

config: Option<PathBuf>

Path to the configuration file

help: bool

Obtain help about the current command

verbose: bool

Increase verbosity setting

command: Option<Cmd>

Subcommand to execute.

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

Trait Implementations

impl<Cmd> Command for EntryPoint<Cmd> where
    Cmd: Runnable + Command, 

fn name() -> &'static str

Name of this program as a string

fn description() -> &'static str

Description of this program

fn version() -> &'static str

Version of this program

fn authors() -> &'static str

Authors of this program

fn subcommand_usage(command: &str) -> Option<Usage>

Get usage information for a particular subcommand (if available)

fn from_args<A: IntoIterator<Item = String>>(into_args: A) -> Self

Parse command-line arguments from a string iterator

fn from_env_args() -> Self

Parse command-line arguments from the environment

fn print_usage_and_exit(args: &[String]) -> !

Print usage information and exit

impl<Cfg, Cmd> Configurable<Cfg> for EntryPoint<Cmd> where
    Cmd: Runnable + Command,
    Cfg: Config, 

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

Path to the command's configuration file

fn load_config_file<P: AsRef<AbsPath>>(
    &self,
    path: &P
) -> Result<C, FrameworkError>

Load the configuration for this command

fn preprocess_config(&self, config: C) -> Result<C, FrameworkError>

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

impl<Cmd> Runnable for EntryPoint<Cmd> where
    Cmd: Runnable + Command, 

fn run(&self)

Run this Runnable

impl<Cmd: Debug + Runnable + Command> Debug for EntryPoint<Cmd>

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

Formats the value using the given formatter.

impl<Cmd: Runnable + Command> Options for EntryPoint<Cmd>

fn parse<__S: AsRef<str>>(_parser: &mut Parser<__S>) -> Result<Self, Error>

Parses arguments until the given parser is exhausted or until an error is encountered.

fn command_name(&self) -> Option<&'static str>

Returns the name of a parsed command, if present.

fn help_requested(&self) -> bool

Returns whether the user supplied a "help" option to request usage information about the program or any contained subcommands.

fn parse_command<__S: AsRef<str>>(
    name: &str,
    _parser: &mut Parser<__S>
) -> Result<Self, Error>

Parses options for the named command.

fn usage() -> &'static str

Returns a string showing usage and help for each supported option.

fn command_list() -> Option<&'static str>

Returns a string listing available commands and help text.

fn command_usage(_name: &str) -> Option<&'static str>

Returns a usage string for the named command.

fn parse_args<S>(args: &[S], style: ParsingStyle) -> Result<Self, Error> where
    S: AsRef<str>, 

Parses arguments received from the command line.

fn parse_args_or_exit(style: ParsingStyle) -> Self

Parses arguments from the environment.

fn parse_args_default_or_exit() -> Self

Parses arguments from the environment, using the default parsing style.

fn parse_args_default<S>(args: &[S]) -> Result<Self, Error> where
    S: AsRef<str>, 

Parses arguments received from the command line, using the default parsing style.