Enum Argument

pub enum Argument<'a> {
    Long(&'a str),
    Short(&'a str),
    Bare(&'a str),
}

A single argument that can be matched from an ArgumentIterator.

Variants

Long(&'a str)

A long argument without the leading dashes.
Argument::Long("help") == arg!(--help)

Short(&'a str)

A short argument without the leading dash.
Argument::Short("h") == arg!(-h)

Important to note that it must be only 1 character long or it will never match, but for ergonimic reasons it is actually a &str.

Bare(&'a str)

Raw string of anything else passed as an argument, whether it has zero or three dashes. Manually constructing an invalid bare argument with leading dashes won’t be matched properly.
Argument::Bare("---yeet") == arg!("---yeet")

Exists as an alternative to putting parsed arguments in a Result.

Implementations

impl Argument<'_>

pub fn is_long(&self) -> bool

pub fn is_short(&self) -> bool

pub fn is_bare(&self) -> bool

Trait Implementations

impl<'a> Clone for Argument<'a>

fn clone(&self) -> Argument<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Argument<'a>

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

Formats the value using the given formatter.

impl Display for Argument<'_>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Argument<'a>

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

impl<'a> StructuralPartialEq for Argument<'a>