Skip to main content

Command

Struct Command 

Source
pub struct Command {
    pub name: &'static str,
    pub about: &'static str,
    pub long_about: &'static str,
    pub after_help: &'static str,
    pub after_long_help: &'static str,
    pub items: &'static [Item],
    pub subcommands: &'static [Sub],
    pub subcommand_required: bool,
    pub help_flag: bool,
    pub help_short: bool,
    pub version: Option<&'static str>,
}
Expand description

One command’s help: what it is, what it takes, what it contains.

Written by the derive, as Item and Sub are: fields are added as help learns to show more, so a hand-written one tracks the release.

Fields§

§name: &'static str

The command’s own name; empty for a root that leaves it to argv[0].

§about: &'static str

First paragraph of the description.

§long_about: &'static str

The whole description, for --help.

§after_help: &'static str

Text after the lists, for -h.

§after_long_help: &'static str

Text after the lists, for --help.

§items: &'static [Item]

Flags and positionals, in declaration order.

§subcommands: &'static [Sub]

Subcommands, in declaration order.

§subcommand_required: bool

Whether a subcommand must be given.

§help_flag: bool

Whether --help is supplied (not declared or disabled).

§help_short: bool

Whether the supplied help flag has -h as well as --help.

§version: Option<&'static str>

The version, when -V/--version are supplied.

Trait Implementations§

Source§

impl Debug for Command

Source§

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

Formats the value using the given formatter. Read more

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.