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).

Examples

App::new("myprog")
    .subcommand(
        SubCommand::with_name("config")
            .about("Used for configuration")
            .arg(Arg::with_name("config_file")
                .help("The configuration file to use")
                .index(1)))

Implementations

impl<'a> SubCommand<'a>

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

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.

Examples

App::new("myprog")
    .subcommand(
        SubCommand::with_name("config"))

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

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

Examples

let sc_yaml = load_yaml!("test_subcommand.yml");
let sc = SubCommand::from_yaml(sc_yaml);

Trait Implementations

impl<'a> Clone for SubCommand<'a>

fn clone(&self) -> SubCommand<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SubCommand<'a>

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

Formats the value using the given formatter.