Skip to main content

Command

Struct Command 

Source
pub struct Command {
    pub name: String,
    pub about: String,
    pub long_about: String,
    pub args: Vec<Arg>,
    pub flags: Vec<Flag>,
    pub examples: Vec<String>,
    pub destructive: bool,
    pub subcommands: Vec<Command>,
}
Expand description

A subcommand. The run closure is stored on the app side; this struct holds only the descriptive spec used for parsing and help.

Fields§

§name: String§about: String§long_about: String

A longer description shown in the command’s own --help.

§args: Vec<Arg>§flags: Vec<Flag>§examples: Vec<String>

Example invocations shown in long help.

§destructive: bool

Marks the command as performing destructive on-disk changes, so the app can enforce the confirmation/--sudo guards.

§subcommands: Vec<Command>

Child command specs, when this command is a group. Populated by the app’s group builder so help and completion can render the nested tree. Empty for leaf commands.

Implementations§

Source§

impl Command

Source

pub fn new<S: Into<String>>(name: S) -> Self

Source

pub fn is_group(&self) -> bool

Whether this command is a group (has child subcommands).

Trait Implementations§

Source§

impl Clone for Command

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.