Struct CommandLine

pub struct CommandLine { /* private fields */ }

Represents a command-line app.

Implementations

impl CommandLine

pub fn new(root: Command) -> Self

Constructs a new CommandLine with the provided Command.

pub fn with_context(context: Context) -> Self

Constructs a new CommandLine with the provided Context.

pub fn context(&self) -> &Context

Returns the Context used by this command-line.

pub fn root(&self) -> &Command

Returns the Command used by this command-line.

pub fn suggestions(&self) -> Option<&SuggestionSource>

Returns the SuggestionProvider used by this command-line.

pub fn use_default_help(self) -> Self

Sets the default Help.

pub fn use_default_suggestions(self) -> Self

Sets the default SuggestionProvider.

pub fn use_suggestions(self, suggestions: SuggestionSource) -> Self

Sets the SuggestionSource of this command-line context.

pub fn use_help(self, help: HelpSource) -> Self

Sets the HelpSource of this command-line context.

pub fn use_help_option(self, option: CommandOption) -> Self

Sets the help option for this command-line context.

pub fn use_help_command(self, command: Command) -> Self

Sets the help command for this command-line context.

pub fn use_version_option(self, option: CommandOption) -> Self

Sets the version option for this command-line context.

pub fn use_version_command(self, command: Command) -> Self

Sets the version command for this command-line context.

pub fn parse_args(&mut self) -> Result<ParseResult>

Parse the program arguments get the ParseResult after handling any help, version or suggestion messages.

pub fn parse_from<S, I>(&mut self, args: I) -> Result<ParseResult>

where S: Borrow<str>, I: IntoIterator<Item = S>,

Parse given arguments get the ParseResult after handling any help, version or suggestion messages.

pub fn run(&mut self) -> Result<()>

Parse the program arguments and runs the app.

This is equivalent to CommandLine::parse_from(std::env::args().skip(1)).

pub fn run_from<S, I>(&mut self, args: I) -> Result<()>

where S: Borrow<str>, I: IntoIterator<Item = S>,

Parses the given arguments and runs the app.

Trait Implementations

impl Debug for CommandLine

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

Formats the value using the given formatter.