Skip to main content

Command

Struct Command 

Source
pub struct Command { /* private fields */ }
Expand description

A single registered subcommand.

Build with Command::new and configure via the builder methods before passing to App::add_command.

Implementations§

Source§

impl Command

Source

pub fn new(name: impl Into<String>, handler: fn(&CommandContext)) -> Self

Creates a new command with the given name and handler function.

The handler receives a CommandContext containing the resolved flags and positional arguments for this invocation.

Source

pub fn description(self, description: impl Into<String>) -> Self

Sets the short description shown in the app-level help listing.

Source

pub fn usage(self, usage: impl Into<String>) -> Self

Sets the usage string shown when the user runs <cmd> --help.

Displayed as: <prog> <cmd> <usage>. For example, passing "<file> [--output <path>]" produces mytool convert <file> [--output <path>].

If omitted and the command has registered flags, a fallback of [options] is shown.

Source

pub fn strict_flags(self, strict: bool) -> Self

Controls whether unknown flags cause a hard error or just a warning.

When true, passing an unrecognized flag prints an error and exits without calling the handler. When false (the default), a warning is printed and execution continues. Global flags are always considered known and never trigger this check.

Source

pub fn flag(self, flag: Flag) -> Self

Registers a flag definition for this command.

Registered flags participate in alias resolution and appear in help text. Can be called multiple times to register multiple flags.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.