# Struct clap_lex::ParsedArg

source · [−]

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

Expand description

Command-line Argument

## Implementations

source

### impl<'s> ParsedArg<'s>

source

#### pub fn is_empty(&self) -> bool

Argument is length of 0

source

#### pub fn is_stdio(&self) -> bool

Does the argument look like a stdio argument (`-`)

source

#### pub fn is_escape(&self) -> bool

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

source

#### pub fn is_number(&self) -> bool

Does the argument look like a number

source

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

Treat as a long-flag

source

#### pub fn is_long(&self) -> bool

Can treat as a long-flag

source

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

Treat as a short-flag

source

#### pub fn is_short(&self) -> bool

Can treat as a short-flag

source

#### pub fn to_value_os(&self) -> &RawOsStr

Treat as a value

NOTE: May return a flag or an escape.

source

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

Treat as a value

NOTE: May return a flag or an escape.

source

#### 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

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from `source`. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

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

Feeds this value into the given `Hasher`. Read more

1.3.0 · source

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

Feeds a slice of this type into the given `Hasher`. Read more

source

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

source

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

This method returns an `Ordering` between `self` and `other`. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

#### fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,

Restrict a value to a certain interval. Read more

source

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

source

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

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

source

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

This method tests for `!=`.

source

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

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

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

source

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

source

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

## Auto Trait Implementations

### impl<'s> RefUnwindSafe for ParsedArg<'s>

### impl<'s> Send for ParsedArg<'s>

### impl<'s> Sync for ParsedArg<'s>

### impl<'s> Unpin for ParsedArg<'s>

### impl<'s> UnwindSafe for ParsedArg<'s>

## Blanket Implementations

source

### impl<T> Any for T where
T: 'static + ?Sized,

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source

### impl<T> ToOwned for T where
T: Clone,

#### type Owned = T

The resulting type after obtaining ownership.

source

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.