Struct Argument 

pub struct Argument {
    pub name: String,
    pub description: String,
    pub aliases: Vec<String>,
    pub value: Option<String>,
    pub required: bool,
}

Fields

name: String

Canonical Argument name, for example: “verbose”.

description: String

Human-readable description for help output.

aliases: Vec<String>

Alternative spellings accepted during parsing.

value: Option<String>

Numeric payload that can be mapped to an enum or bit mask.

required: bool

Whether this argument is required or optional.

Implementations

impl Argument

pub fn new(name: impl Into<String>, description: impl Into<String>) -> Self

Creates a Argument declaration with the given numeric payload.

pub fn with_aliases(self, aliases: Vec<impl Into<String>>) -> Self

Adds alias spellings for this Argument.

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

Sets the value for this argument.

pub fn set_required(self) -> Self

Sets required to true, indicating this argument is required.

Trait Implementations

impl Clone for Argument

fn clone(&self) -> Argument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Argument

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

Formats the value using the given formatter.

impl PartialEq for Argument

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

impl StructuralPartialEq for Argument