Enum getargs::Arg

source · [−]

pub enum Arg<A: Argument> {
    Short(A::ShortOpt),
    Long(A),
    Positional(A),
}

Expand description

An option or positional argument.

This enum can be returned by calls to Options::next_arg and represents a short or long command-line option name (but not value) like Opt, or a positional argument.

Variants

`Short(A::ShortOpt)`

A short option, like -f. Does not include the leading -.

`Long(A)`

A long option, like --file. Does not include the leading --.

`Positional(A)`

A positional argument, like foo.txt.

Implementations

source

impl<A: Argument> Arg<A>

source

pub fn opt(self) -> Option<Opt<A>>

Retrieves an equivalent Opt represented by this Arg, if it is Arg::Short or Arg::Long, otherwise None.

source

pub fn positional(self) -> Option<A>

Returns the positional Argument represented by this Arg, if it is Arg::Positional, otherwise None.

Trait Implementations

source

impl<A: Clone + Argument> Clone for Arg<A> where
A::ShortOpt: Clone,

source

fn clone(&self) -> Arg<A>

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<A: Debug + Argument> Debug for Arg<A> where
A::ShortOpt: Debug,

source

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

Formats the value using the given formatter. Read more

source

impl<S: Display, A: Argument<ShortOpt = S> + Display> Display for Arg<A>

source

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

Formats the value using the given formatter. Read more

source

impl<A: Argument> From<A> for Arg<A>

source

fn from(arg: A) -> Self

Converts to this type from the input type.

source

impl<A: Argument> From<Opt<A>> for Arg<A>

source

fn from(opt: Opt<A>) -> Self

Converts to this type from the input type.

source

impl<A: PartialEq + Argument> PartialEq<Arg<A>> for Arg<A> where
A::ShortOpt: PartialEq,

source

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

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

source

fn ne(&self, other: &Arg<A>) -> bool

This method tests for !=.

source

impl<A: Argument> TryFrom<Arg<A>> for Opt<A>

type Error = ()

The type returned in the event of a conversion error.

source

fn try_from(value: Arg<A>) -> Result<Self, Self::Error>

Performs the conversion.

source

impl<A: Argument> StructuralPartialEq for Arg<A>

Auto Trait Implementations

impl<A> RefUnwindSafe for Arg<A> where
A: RefUnwindSafe,
<A as Argument>::ShortOpt: RefUnwindSafe,

impl<A> Send for Arg<A> where
A: Send,
<A as Argument>::ShortOpt: Send,

impl<A> Sync for Arg<A> where
A: Sync,
<A as Argument>::ShortOpt: Sync,

impl<A> Unpin for Arg<A> where
A: Unpin,
<A as Argument>::ShortOpt: Unpin,

impl<A> UnwindSafe for Arg<A> where
A: UnwindSafe,
<A as Argument>::ShortOpt: UnwindSafe,

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<!> for T

const: unstable · source

fn from(t: !) -> T

Converts to this type from the input type.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into 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> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Enum getargs::Arg

Variants

Short(A::ShortOpt)

Long(A)

Positional(A)

Implementations

impl<A: Argument> Arg<A>

pub fn opt(self) -> Option<Opt<A>>

pub fn positional(self) -> Option<A>

Trait Implementations

impl<A: Clone + Argument> Clone for Arg<A> where A::ShortOpt: Clone,

fn clone(&self) -> Arg<A>

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

impl<A: Debug + Argument> Debug for Arg<A> where A::ShortOpt: Debug,

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

impl<S: Display, A: Argument<ShortOpt = S> + Display> Display for Arg<A>

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

impl<A: Argument> From<A> for Arg<A>

fn from(arg: A) -> Self

impl<A: Argument> From<Opt<A>> for Arg<A>

fn from(opt: Opt<A>) -> Self

impl<A: PartialEq + Argument> PartialEq<Arg<A>> for Arg<A> where A::ShortOpt: PartialEq,

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

fn ne(&self, other: &Arg<A>) -> bool

impl<A: Argument> TryFrom<Arg<A>> for Opt<A>

type Error = ()

fn try_from(value: Arg<A>) -> Result<Self, Self::Error>

impl<A: Copy + Argument> Copy for Arg<A> where A::ShortOpt: Copy,

impl<A: Eq + Argument> Eq for Arg<A> where A::ShortOpt: Eq,

impl<A: Argument> StructuralEq for Arg<A>

impl<A: Argument> StructuralPartialEq for Arg<A>

Auto Trait Implementations

impl<A> RefUnwindSafe for Arg<A> where A: RefUnwindSafe, <A as Argument>::ShortOpt: RefUnwindSafe,

impl<A> Send for Arg<A> where A: Send, <A as Argument>::ShortOpt: Send,

impl<A> Sync for Arg<A> where A: Sync, <A as Argument>::ShortOpt: Sync,

impl<A> Unpin for Arg<A> where A: Unpin, <A as Argument>::ShortOpt: Unpin,

impl<A> UnwindSafe for Arg<A> where A: UnwindSafe, <A as Argument>::ShortOpt: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<!> for T

fn from(t: !) -> T

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

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

type Error = Infallible

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

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

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

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

`Short(A::ShortOpt)`

`Long(A)`

`Positional(A)`

impl<A: Clone + Argument> Clone for Arg<A> where
A::ShortOpt: Clone,

impl<A: Debug + Argument> Debug for Arg<A> where
A::ShortOpt: Debug,

impl<A: PartialEq + Argument> PartialEq<Arg<A>> for Arg<A> where
A::ShortOpt: PartialEq,

impl<A: Copy + Argument> Copy for Arg<A> where
A::ShortOpt: Copy,

impl<A: Eq + Argument> Eq for Arg<A> where
A::ShortOpt: Eq,

impl<A> RefUnwindSafe for Arg<A> where
A: RefUnwindSafe,
<A as Argument>::ShortOpt: RefUnwindSafe,

impl<A> Send for Arg<A> where
A: Send,
<A as Argument>::ShortOpt: Send,

impl<A> Sync for Arg<A> where
A: Sync,
<A as Argument>::ShortOpt: Sync,

impl<A> Unpin for Arg<A> where
A: Unpin,
<A as Argument>::ShortOpt: Unpin,

impl<A> UnwindSafe for Arg<A> where
A: UnwindSafe,
<A as Argument>::ShortOpt: UnwindSafe,

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

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

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

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

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

impl<T> ToString for T where
T: Display + ?Sized,

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

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