Struct SurfaceCommand 

pub struct SurfaceCommand {
    pub name: String,
    pub path: String,
    pub aliases: Vec<String>,
    pub visible_aliases: Vec<String>,
    pub hidden: bool,
    pub about: String,
    pub arguments: Vec<SurfaceArgument>,
    pub inherited_arguments: Vec<SurfaceArgument>,
    pub commands: Vec<Self>,
}

One command in a Surface.

Fields

name: String

Command name.

path: String

Full command path below the root.

aliases: Vec<String>

All declared aliases, including hidden aliases.

visible_aliases: Vec<String>

Aliases Clap exposes in help and completion.

hidden: bool

Whether Clap hides this command.

about: String

Command description.

arguments: Vec<SurfaceArgument>

Arguments and flags declared directly on this command, in Clap order.

Ancestor globals remain on their declaring command instead of being duplicated into every descendant.

inherited_arguments: Vec<SurfaceArgument>

Ancestor global arguments this command also accepts, root-first.

commands: Vec<Self>

Nested subcommands in Clap declaration order.

Trait Implementations

impl Clone for SurfaceCommand

fn clone(&self) -> SurfaceCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurfaceCommand

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

Formats the value using the given formatter.

impl Eq for SurfaceCommand

impl PartialEq for SurfaceCommand

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SurfaceCommand

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SurfaceCommand