Struct OpenCliCommand 

pub struct OpenCliCommand {
    pub name: String,
    pub aliases: Vec<String>,
    pub options: Vec<OpenCliOption>,
    pub arguments: Vec<OpenCliArgument>,
    pub commands: Vec<OpenCliCommand>,
    pub exit_codes: Vec<OpenCliExitCode>,
    pub description: Option<String>,
    pub hidden: Option<bool>,
    pub examples: Vec<String>,
    pub interactive: Option<bool>,
    pub metadata: Vec<OpenCliMetadata>,
}

Fields

name: String

The command name

aliases: Vec<String>

The command aliases

options: Vec<OpenCliOption>

The command’s options

arguments: Vec<OpenCliArgument>

The command’s arguments

commands: Vec<OpenCliCommand>

The command’s sub commands

exit_codes: Vec<OpenCliExitCode>

The command’s exit codes

description: Option<String>

The command description

hidden: Option<bool>

Whether or not the command is hidden

examples: Vec<String>

Examples of how to use the command

interactive: Option<bool>

Indicates whether or not the command requires interactive input

metadata: Vec<OpenCliMetadata>

Custom metadata

Trait Implementations

impl Clone for OpenCliCommand

fn clone(&self) -> OpenCliCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenCliCommand

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

Formats the value using the given formatter.

impl Default for OpenCliCommand

fn default() -> OpenCliCommand

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpenCliCommand

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OpenCliCommand

fn eq(&self, other: &OpenCliCommand) -> 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 Serialize for OpenCliCommand

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 OpenCliCommand