Struct clap::SubCommand

pub struct SubCommand<'a> {
    pub name: String,
    pub matches: ArgMatches<'a>,
}

Expand description

The abstract representation of a command line subcommand used by the consumer of the library.

This struct is used by the library consumer and describes all the valid options of the subcommand for their program. SubCommands are treated like “sub apps” and contain all the same possibilities (such as their own arguments and subcommands).

§Example

SubCommand::new("conifg")
               .about("Used for configuration")
               .arg(Arg::new("config_file")
                          .help("The configuration file to use")
                          .index(1))

Fields§

§name: String§matches: ArgMatches<'a>

Implementations§

impl<'a> SubCommand<'a>

pub fn new<'n, 'au, 'v, 'ab, 'u, 'ar>( name: &'n str, ) -> App<'au, 'v, 'ab, 'u, 'ar>

Creates a new instance of a subcommand requiring a name. Will be displayed to the user when they print version or help and usage information.

§Example

SubCommand::new("config")

Auto Trait Implementations§

impl<'a> Freeze for SubCommand<'a>

impl<'a> RefUnwindSafe for SubCommand<'a>

impl<'a> Send for SubCommand<'a>

impl<'a> Sync for SubCommand<'a>

impl<'a> Unpin for SubCommand<'a>

impl<'a> UnwindSafe for SubCommand<'a>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.