Struct CommandMapActionCommand

pub struct CommandMapActionCommand<'a> { /* private fields */ }

An ActionCommand that only composes a CommandMap’s subcommands. Any customization of the clap::Command or the behavior of CommandMapActionCommand::action will require a custom type.

// create a new CommandMapActionCommand, including all of the
// subcommands it must dispatch to.
let foo = CommandMapActionCommand::new(
    "foo",
    CommandMap::builder()
        .push(HelloWorldCommand {})
        .build(),
);
// add that CommandMapActionCommand to its parent CommandMap, which
// will automatically dispatch and route to subcommands
let command_map = CommandMap::builder()
    .push(foo)
    .build();

Implementations

impl<'a> CommandMapActionCommand<'a>

pub fn new( name: &'static str, command_map: CommandMap<'a>, ) -> CommandMapActionCommand<'a>

Create a new CommandMapActionCommand give a name and a CommandMap.

Trait Implementations

impl<'a> ActionCommand for CommandMapActionCommand<'a>

fn name(&self) -> &'static str

The name of the command.

fn command(&self, command: Command) -> Command

The Command that describes how to match this on the command line using Clap. command is already constructed using Self::name for convenience.

fn action(&self, matches: Vec1<&ArgMatches>) -> Result<(), Box<dyn Error>>

The action to take when this command is matched on the command line. CommandMaps may be nested, and this is represented by the matches being returned as a list of at least one element.