Struct abscissa_core::Help

pub struct Help<C: Command> {
    pub opts: Vec<String>,
    // some fields omitted
}

Help command which prints usage information.

Generic over Command types.

Fields

opts: Vec<String>

Obtain help for a particular subcommand

Trait Implementations

impl<C> Command for Help<C> where
    C: 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 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

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

Get usage information for a particular subcommand (if available)

impl<C> Runnable for Help<C> where
    C: Command, 

fn run(&self)

Print help information for the given command

impl<C: Default + Command> Default for Help<C>

fn default() -> Help<C>

Returns the "default value" for a type.

impl<C: Debug + Command> Debug for Help<C>

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

Formats the value using the given formatter.

impl<C> Options for Help<C> where
    C: Command, 

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 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_usage(_command: &str) -> Option<&'static str>

Returns a usage string for the named command.

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

Returns a string listing available commands and help text.

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