Struct ArgumentSpec 

pub struct ArgumentSpec {

    pub name: String,
    pub long: Option<String>,
    pub short: Option<char>,
    pub positional: bool,
    pub takes_value: bool,
    pub required: bool,
    pub variadic: bool,
    pub global: bool,
    pub help: String,
    pub value_name: Option<String>,
    pub values: Vec<ValueChoice>,
    pub defaults: Vec<String>,
    pub source: ValueSource,
    pub secrecy: Secrecy,
}

One argument of a command, as the declaration gives it plus what can be inferred.

Fields

name: String

The argument’s id.

long: Option<String>

--long, without the dashes.

short: Option<char>

-s, without the dash.

positional: bool

Given by position rather than by flag.

takes_value: bool

Takes a value at all; a flag does not.

required: bool

Must be given.

variadic: bool

Takes any number of values.

global: bool

Accepted by every command under the one that declares it.

help: String

The help text, one line.

value_name: Option<String>

The placeholder, PATH.

values: Vec<ValueChoice>

The values the declaration carries, each with its help.

defaults: Vec<String>

The defaults, as the declaration renders them.

source: ValueSource

Where further values come from.

secrecy: Secrecy

How openly the value may be handled.

Trait Implementations

impl Clone for ArgumentSpec

fn clone(&self) -> ArgumentSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArgumentSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ArgumentSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ArgumentSpec

impl JsonSchema for ArgumentSpec

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ArgumentSpec

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

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 ArgumentSpec