Struct clap_lex::ParsedArg

pub struct ParsedArg<'s> { /* private fields */ }

Command-line Argument

Implementations

impl<'s> ParsedArg<'s>

pub fn is_empty(&self) -> bool

Argument is length of 0

pub fn is_stdio(&self) -> bool

Does the argument look like a stdio argument (-)

pub fn is_escape(&self) -> bool

Does the argument look like an argument escape (--)

pub fn is_negative_number(&self) -> bool

Does the argument look like a negative number?

This won’t parse the number in full but attempts to see if this looks like something along the lines of -3, -0.3, or -33.03

pub fn to_long(&self) -> Option<(Result<&str, &OsStr>, Option<&OsStr>)>

Treat as a long-flag

pub fn is_long(&self) -> bool

Can treat as a long-flag

pub fn to_short(&self) -> Option<ShortFlags<'_>>

Treat as a short-flag

pub fn is_short(&self) -> bool

Can treat as a short-flag

pub fn to_value_os(&self) -> &OsStr

Treat as a value

NOTE: May return a flag or an escape.

pub fn to_value(&self) -> Result<&str, &OsStr>

Treat as a value

NOTE: May return a flag or an escape.

pub fn display(&self) -> impl Display + '_

Safely print an argument that may contain non-UTF8 content

This may perform lossy conversion, depending on the platform. If you would like an implementation which escapes the path please use Debug instead.

Trait Implementations

impl<'s> Clone for ParsedArg<'s>

fn clone(&self) -> ParsedArg<'s>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'s> Debug for ParsedArg<'s>

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

Formats the value using the given formatter.

impl<'s> Hash for ParsedArg<'s>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'s> Ord for ParsedArg<'s>

fn cmp(&self, other: &ParsedArg<'s>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'s> PartialEq for ParsedArg<'s>

fn eq(&self, other: &ParsedArg<'s>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'s> PartialOrd for ParsedArg<'s>

fn partial_cmp(&self, other: &ParsedArg<'s>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'s> Eq for ParsedArg<'s>

impl<'s> StructuralEq for ParsedArg<'s>

impl<'s> StructuralPartialEq for ParsedArg<'s>