Struct CliArg 

pub struct CliArg {
    pub field: &'static str,
    pub short: Option<char>,
    pub position: Option<usize>,
    pub long: Option<&'static str>,
}

Presentation for one of a command’s parameters.

Only the parameters that need something beyond the default are declared. The default is a kebab-cased long flag, which is what most parameters want.

Fields

field: &'static str

Parameter name as the command deserializes it, e.g. harness_name.

short: Option<char>

Short option, when the parameter is common enough to earn one.

Short options are declared, never derived: deriving from first letters collides, and worse, shifts as fields are added, so a script written today breaks when an unrelated parameter appears next to it.

position: Option<usize>

Position when the parameter is also spelled as a bare word, 1-based.

long: Option<&'static str>

Long spelling, when it differs from the kebab-cased field name.

Implementations

impl CliArg

pub const fn new(field: &'static str) -> Self

pub const fn short(self, short: char) -> Self

Give this parameter a short option, e.g. -H for --harness.

pub const fn at(self, position: usize) -> Self

Also accept this parameter as a bare word at position (1-based).

pub const fn long(self, long: &'static str) -> Self

Spell the long flag differently from the field name, e.g. the field harness_name spelled --harness.

Trait Implementations

impl Clone for CliArg

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CliArg

impl Debug for CliArg

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

Formats the value using the given formatter.

impl Eq for CliArg

impl PartialEq for CliArg

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CliArg