Enum abscissa::commands::CliCommand

pub enum CliCommand {
    Gen(GenCommand),
    Help(Help<Self>),
    New(NewCommand),
    Version(VersionCommand),
}

Abscissa CLI Subcommands

Variants

Gen(GenCommand)

Help(Help<Self>)

New(NewCommand)

Version(VersionCommand)

Trait Implementations

impl Command for CliCommand

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 the named subcommand

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

Parse command-line arguments from a string iterator

pub fn from_env_args() -> Self

Parse command-line arguments from the environment

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

Print usage information and exit

impl Configurable<CliConfig> for CliCommand

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

Path to the command's configuration file. Returns an error by default.

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

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

impl Debug for CliCommand

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

Formats the value using the given formatter.

impl Options for CliCommand

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.

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

Parses arguments received from the command line.

pub fn parse_args_or_exit(style: ParsingStyle) -> Self

Parses arguments from the environment.

pub fn parse_args_default_or_exit() -> Self

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

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

impl Runnable for CliCommand

fn run(&self)

Run this Runnable