Struct ArgDef 

pub struct ArgDef {
    pub id: String,
    pub value_name: Option<String>,
    pub help: Option<String>,
    pub help_heading: Option<String>,
    pub required: bool,
    pub multi: bool,
    pub value_kind: Option<ValueKind>,
    pub choices: Vec<ValueChoice>,
    pub defaults: Vec<String>,
}

Positional argument definition for a command.

Fields

id: String

Stable identifier for the argument.

value_name: Option<String>

Placeholder shown for the argument value in help text.

help: Option<String>

Help text shown for the argument.

help_heading: Option<String>

Optional help section heading for the argument.

required: bool

Whether the argument must be supplied.

multi: bool

Whether the argument accepts multiple values.

value_kind: Option<ValueKind>

Semantic hint for completions and UI presentation.

choices: Vec<ValueChoice>

Enumerated values suggested for the argument.

defaults: Vec<String>

Default values applied when the argument is omitted.

Implementations

impl ArgDef

pub fn new(id: impl Into<String>) -> Self

Creates a positional argument definition with the provided identifier.

pub fn value_name(self, value_name: impl Into<String>) -> Self

Sets the displayed value name for the argument.

pub fn help(self, help: impl Into<String>) -> Self

Sets the help text for the argument.

pub fn required(self) -> Self

Marks the argument as required.

pub fn multi(self) -> Self

Marks the argument as accepting multiple values.

pub fn value_kind(self, value_kind: ValueKind) -> Self

Sets the semantic value kind for the argument.

pub fn choices(self, choices: impl IntoIterator<Item = ValueChoice>) -> Self

Appends supported value choices for the argument.

pub fn defaults( self, defaults: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Appends default values for the argument.

Trait Implementations

impl Clone for ArgDef

fn clone(&self) -> ArgDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArgDef

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

Formats the value using the given formatter.

impl Default for ArgDef

fn default() -> ArgDef

Returns the “default value” for a type.

impl From<&ArgDef> for DescribeArgV1

fn from(arg: &ArgDef) -> Self

Converts to this type from the input type.

impl From<&DescribeArgV1> for ArgDef

fn from(arg: &DescribeArgV1) -> Self

Converts to this type from the input type.

impl PartialEq for ArgDef

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

impl StructuralPartialEq for ArgDef