[][src]Struct clap::SubCommand

pub struct SubCommand<'a> { /* fields omitted */ }

The abstract representation of a command line subcommand.

This struct describes all the valid options of the subcommand for the program. Subcommands are essentially "sub-Apps" and contain all the same possibilities (such as their own arguments, subcommands, and settings).


            .about("Used for configuration")
                .help("The configuration file to use")


impl<'a> SubCommand<'a>[src]

pub fn with_name<'b>(name: &str) -> App<'a, 'b>[src]

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



pub fn from_yaml(yaml: &Yaml) -> App<'_, '_>[src]

Creates a new instance of a subcommand from a YAML (.yml) document


This example is not tested
let sc_yaml = load_yaml!("test_subcommand.yml");
let sc = SubCommand::from_yaml(sc_yaml);

Trait Implementations

impl<'a> Clone for SubCommand<'a>[src]

impl<'a> Debug for SubCommand<'a>[src]

Auto Trait Implementations

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

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

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

impl<T> From<T> for T[src]

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

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

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

type Error = Infallible

The type returned in the event of a conversion error.

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.