Type Alias CommandInfoWithArgs

pub type CommandInfoWithArgs = CommandInfoWithArgs<'static>;

Information about the command including the options and arguments.

Aliased Type

struct CommandInfoWithArgs {
    pub name: &'static str,
    pub description: &'static str,
    pub examples: &'static [&'static str],
    pub flags: &'static [FlagInfo<'static>],
    pub notes: &'static [&'static str],
    pub commands: Vec<SubCommandInfo<'static>>,
    pub positionals: &'static [PositionalInfo<'static>],
    pub error_codes: &'static [ErrorCodeInfo<'static>],
}

Fields

name: &'static str

The name of the command.

description: &'static str

A short description of the command’s functionality.

examples: &'static [&'static str]

Examples of usage

flags: &'static [FlagInfo<'static>]

Flags

notes: &'static [&'static str]

Notes about usage

commands: Vec<SubCommandInfo<'static>>

The subcommands.

positionals: &'static [PositionalInfo<'static>]

Positional args

error_codes: &'static [ErrorCodeInfo<'static>]

Error code information

Trait Implementations

impl<'a> Clone for CommandInfoWithArgs<'a>

fn clone(&self) -> CommandInfoWithArgs<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CommandInfoWithArgs<'a>

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

Formats the value using the given formatter.

impl<'a> Default for CommandInfoWithArgs<'a>

fn default() -> CommandInfoWithArgs<'a>

Returns the “default value” for a type.

impl<'a> PartialEq for CommandInfoWithArgs<'a>

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for CommandInfoWithArgs<'a>

impl<'a> StructuralPartialEq for CommandInfoWithArgs<'a>