Struct shli::completion::Command

pub struct Command {
    pub name: String,
    pub args: Vec<Argument>,
    pub subcommands: Vec<Command>,
}

Possible (sub)command displayed in tab completion.

The arguments right from a (sub)command may be flags, arbitrary arguments or even subcommands. They all can be displayed or even tab-completed, when described in this data structure’s attributes.

use shli::Command;

let cmd = Command::new("exit");

Fields

name: String

The name of the command that shall be completed

args: Vec<Argument>

If calling completion after the name, the arguments may be completed

subcommands: Vec<Command>

If calling completion after a subcommand, it may be completed

Implementations

impl Command

pub fn new(name: &str) -> Command

Create a new instance by specifying the command’s name

pub fn subcommand(self, cmd: Command) -> Command

Add a subcommand to this command

use shli::Command;

let cmd = Command::new("config")
    .subcommand(Command::new("commit"));

pub fn arg<T: Into<Argument>>(self, arg: T) -> Command

Add a concrete argument (e.g. a flag) to this command

use shli::Command;

let cmd = Command::new("config").arg("--help");