Struct Arg 

pub struct Arg {
    pub name: String,
    pub variadic: bool,
    pub default: Option<String>,
}

One declared positional argument.

Fields

name: String

variadic: bool

*name: collects all remaining positionals, space-joined.

default: Option<String>

name='default': optional, with this value when not supplied.

Implementations

impl Arg

pub fn is_valid_name(&self) -> bool

Whether this name can actually become the shell variable the script will read.

An argument is bound as an environment variable, so a name that is not a valid identifier cannot ever work. Worth knowing at parse time rather than at unbound variable time, because the shell reports the name the script used, which is spelled correctly, and says nothing about the declaration that is actually wrong.

Trait Implementations

impl Clone for Arg

fn clone(&self) -> Arg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Arg

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

Formats the value using the given formatter.

impl Eq for Arg

impl PartialEq for Arg

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Arg