Struct CommandSpec 

pub struct CommandSpec {
    pub name: String,
    pub tooltip: Option<String>,
    pub sort: Option<String>,
    pub args: Vec<ArgNode>,
    pub flags: BTreeMap<String, FlagNode>,
    pub subcommands: Vec<CommandSpec>,
}

Declarative command description used to build a completion tree.

Fields

name: String

Command or subcommand name.

tooltip: Option<String>

Optional description shown alongside the command.

sort: Option<String>

Optional hidden sort key for display ordering.

args: Vec<ArgNode>

Positional arguments accepted by this command.

flags: BTreeMap<String, FlagNode>

Flags accepted by this command.

subcommands: Vec<CommandSpec>

Nested subcommands below this command.

Implementations

impl CommandSpec

pub fn new(name: impl Into<String>) -> Self

Starts a declarative command spec with the given command name.

pub fn tooltip(self, tooltip: impl Into<String>) -> Self

Attaches the description shown alongside this command in completion UIs.

If omitted, completion UIs show no description for this command.

pub fn sort(self, sort: impl Into<String>) -> Self

Attaches a hidden sort key used to stabilize menu ordering.

If omitted, the command carries no explicit sort hint.

pub fn arg(self, arg: ArgNode) -> Self

Appends one positional argument definition.

If omitted, the command contributes no positional completion metadata.

pub fn args(self, args: impl IntoIterator<Item = ArgNode>) -> Self

Extends the command with positional argument definitions.

If omitted, the command contributes no positional completion metadata.

pub fn flag(self, name: impl Into<String>, flag: FlagNode) -> Self

Adds one flag definition keyed by its spelling.

If omitted, the command contributes no flag completion metadata.

pub fn flags(self, flags: impl IntoIterator<Item = (String, FlagNode)>) -> Self

Extends the command with multiple flag definitions.

If omitted, the command contributes no flag completion metadata.

pub fn subcommand(self, subcommand: CommandSpec) -> Self

Appends one nested subcommand.

If omitted, the command contributes no nested subcommand metadata.

pub fn subcommands( self, subcommands: impl IntoIterator<Item = CommandSpec>, ) -> Self

Extends the command with nested subcommands.

If omitted, the command contributes no nested subcommand metadata.

Trait Implementations

impl Clone for CommandSpec

fn clone(&self) -> CommandSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandSpec

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

Formats the value using the given formatter.

impl Default for CommandSpec

fn default() -> CommandSpec

Returns the “default value” for a type.

impl PartialEq for CommandSpec

fn eq(&self, other: &CommandSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CommandSpec

impl StructuralPartialEq for CommandSpec