Struct ArgDoc 

pub struct ArgDoc {
    pub name: String,
    pub long: Option<String>,
    pub short: Option<char>,
    pub positional: bool,
    pub help: String,
    pub value_name: Option<String>,
    pub takes_value: bool,
    pub required: bool,
    pub global: bool,
    pub possible_values: Vec<PossibleValueDoc>,
    pub defaults: Vec<String>,
}

One argument of a command.

Fields

name: String

The argument’s id, transport.

long: Option<String>

--transport, without the dashes.

short: Option<char>

-t, without the dash.

positional: bool

Given by position rather than by flag.

help: String

The help text.

value_name: Option<String>

The placeholder for the value, PATH.

takes_value: bool

Whether the argument takes a value at all (a flag does not).

required: bool

Must be given.

global: bool

Accepted by every command under the one that declares it.

possible_values: Vec<PossibleValueDoc>

The values a value-enum argument accepts, with the help of each; empty for any other argument. Always present, so a template can ask for its length.

defaults: Vec<String>

The default value(s), as clap renders them; empty when there is none.

Trait Implementations

impl Clone for ArgDoc

fn clone(&self) -> ArgDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArgDoc

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

Formats the value using the given formatter.

impl Eq for ArgDoc

impl PartialEq for ArgDoc

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

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 ArgDoc