Struct SurfaceArgument 

#[non_exhaustive]
pub struct SurfaceArgument {

    pub id: String,
    pub index: Option<usize>,
    pub short: Option<char>,
    pub long: Option<String>,
    pub visible_short_aliases: Vec<char>,
    pub short_aliases: Vec<char>,
    pub visible_aliases: Vec<String>,
    pub aliases: Vec<String>,
    pub value_names: Vec<String>,
    pub help: String,
    pub requirement: SurfaceRequirement,
    pub scope: SurfaceScope,
    pub hidden: bool,
    pub takes_values: bool,
}

Available on crate feature surface-model only.

One positional argument or flag in a Surface, which Surface::new builds. A field can join it in a minor release.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

Clap argument identifier.

index: Option<usize>

Positional index, absent for options and flags.

short: Option<char>

Short flag name.

long: Option<String>

Long flag name without leading dashes.

visible_short_aliases: Vec<char>

Visible short aliases.

short_aliases: Vec<char>

All short aliases, including hidden aliases.

visible_aliases: Vec<String>

Visible long aliases.

aliases: Vec<String>

All long aliases, including hidden aliases.

value_names: Vec<String>

Value names shown by Clap.

help: String

Argument description.

requirement: SurfaceRequirement

Whether Clap requires the argument.

scope: SurfaceScope

Whether Clap propagates the argument to subcommands.

hidden: bool

Whether Clap hides the argument.

takes_values: bool

Whether the argument action accepts values.

Trait Implementations

impl Clone for SurfaceArgument

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurfaceArgument

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

Formats the value using the given formatter.

impl Eq for SurfaceArgument

impl PartialEq for SurfaceArgument

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SurfaceArgument

Available on crate feature surface-serde only.

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 SurfaceArgument