Struct ArgSpec 

pub struct ArgSpec {

    pub id: String,
    pub long: Option<String>,
    pub short: Option<char>,
    pub help: Option<String>,
    pub long_help: Option<String>,
    pub required: bool,
    pub default_values: Vec<String>,
    pub possible_values: Vec<String>,
    pub value_enum: bool,
    pub num_args_min: usize,
    pub num_args_max: Option<usize>,
    pub global: bool,
    pub hidden: bool,
    pub positional: bool,
    pub index: Option<usize>,
    pub action: String,
}

A single CLI argument/flag.

Fields

id: String

Clap argument id (stable identifier used for conflict groups, etc.).

long: Option<String>

Long flag name without leading --.

short: Option<char>

Short flag letter (without leading -).

help: Option<String>

Help text shown in --help.

long_help: Option<String>

Long help text shown in --help.

required: bool

Whether the argument is required.

default_values: Vec<String>

Default values (as shown by clap and used when the argument is absent).

This is always present; an empty list means there is no configured default.

possible_values: Vec<String>

Enumerated possible values for the argument value parser (if known).

This is always present; an empty list means clap does not advertise a finite set of possible values for this argument.

value_enum: bool

Whether the argument’s value is parsed as a clap ValueEnum type.

This is intended for tooling (e.g., rendering dropdowns) and is a best-effort reflection of the clap configuration.

num_args_min: usize

Minimum number of values this argument accepts per occurrence.

num_args_max: Option<usize>

Maximum number of values this argument accepts per occurrence (inclusive).

None means unbounded.

global: bool

Whether the argument is global (propagates to subcommands).

hidden: bool

Whether the argument is hidden from normal help output.

positional: bool

Whether the argument is positional.

index: Option<usize>

For positional arguments, the 1-based index.

action: String

The clap action driving how values are applied (e.g. Set, SetTrue, Append).

Trait Implementations

impl Clone for ArgSpec

fn clone(&self) -> ArgSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArgSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ArgSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ArgSpec

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 ArgSpec

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ArgSpec

impl StructuralPartialEq for ArgSpec