Struct argh_shared::CommandInfoWithArgs

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

Information about the command line arguments for a given command.

Fields

name: &'a str

The name of the command.

description: &'a str

A short description of the command’s functionality.

examples: &'a [&'a str]

Examples of usage

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

Flags

notes: &'a [&'a str]

Notes about usage

commands: Vec<SubCommandInfo<'a>>

The subcommands.

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

Positional args

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

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

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