1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

#[cfg(feature = "yaml")]
use yaml_rust::Yaml;

use App;
use ArgMatches;

/// 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
///
/// ```no_run
/// # use clap::{App, Arg, SubCommand};
/// # let matches = App::new("myprog")
/// #                    .subcommand(
/// SubCommand::with_name("conifg")
///                .about("Used for configuration")
///                .arg(Arg::with_name("config_file")
///                           .help("The configuration file to use")
///                           .index(1))
/// # ).get_matches();
pub struct SubCommand<'n, 'a> {
    #[doc(hidden)]
    pub name: &'n str,
    #[doc(hidden)]
    pub matches: ArgMatches<'n, 'a>,
}

impl<'n, 'a> SubCommand<'n, 'a> {
    /// 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
    ///
    /// ```no_run
    /// # use clap::{App, Arg, SubCommand};
    /// # let prog = App::new("myprog").subcommand(
    /// SubCommand::with_name("config")
    /// # ).get_matches();
    /// ```
    pub fn with_name<'au, 'v, 'ab, 'u, 'h, 'ar>(name: &'ar str) -> App<'au, 'v, 'ab, 'u, 'h, 'ar> {
        App::new(name)
    }

    /// Creates a new instance of a subcommand from a YAML (.yml) document
    ///
    /// # Example
    ///
    /// ```ignore
    /// # use clap::{App, Arg, SubCommand};
    /// let sc_yaml = load_yaml!("test_subcommand.yml");
    /// let sc = SubCommand::from_yaml(sc_yaml);
    /// ```
    #[cfg(feature = "yaml")]
    pub fn from_yaml<'y>(yaml: &'y Yaml) -> App<'y, 'y, 'y, 'y, 'y, 'y> {
        App::from_yaml(yaml)
    }
}