Skip to main content

Event

Enum Event 

Source
pub enum Event<'t, 'a, 'v> {
    Command(&'t Command<'t>),
    Flag {
        flag: &'t Flag<'t>,
        value: Option<&'v [u8]>,
        negated: bool,
    },
    Arg {
        arg: &'t Arg<'t>,
        value: &'v [u8],
        delimit: bool,
    },
    ClauseSeparator {
        clause: Clause<'t>,
    },
    External {
        values: &'a [&'v OsStr],
    },
}
Expand description

Something the parser bound.

Variants§

§

Command(&'t Command<'t>)

A subcommand was selected; parsing continues inside it.

§

Flag

A flag was given. value is Some for a flag that takes one, and negated is true when the flag was set through its negate form.

Fields

§flag: &'t Flag<'t>
§value: Option<&'v [u8]>
§negated: bool
§

Arg

A word was bound to a positional argument. A variadic argument produces one event per value.

Fields

§arg: &'t Arg<'t>
§value: &'v [u8]
§delimit: bool

Whether this value should be split by the argument’s declared delimiter.

§

ClauseSeparator

Ended one clause instance and began the next.

Fields

§clause: Clause<'t>
§

External

An unmatched word was forwarded as an external command: the name, then every remaining token, including flags.

Fields

§values: &'a [&'v OsStr]

Trait Implementations§

Source§

impl<'t, 'a, 'v> Clone for Event<'t, 'a, 'v>

Source§

fn clone(&self) -> Event<'t, 'a, 'v>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'t, 'a, 'v> Copy for Event<'t, 'a, 'v>

Source§

impl<'t, 'a, 'v> Debug for Event<'t, 'a, 'v>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'t, 'a, 'v> Eq for Event<'t, 'a, 'v>

Source§

impl<'t, 'a, 'v> PartialEq for Event<'t, 'a, 'v>

Source§

fn eq(&self, other: &Event<'t, 'a, 'v>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'t, 'a, 'v> StructuralPartialEq for Event<'t, 'a, 'v>

Auto Trait Implementations§

§

impl<'t, 'a, 'v> Freeze for Event<'t, 'a, 'v>

§

impl<'t, 'a, 'v> RefUnwindSafe for Event<'t, 'a, 'v>

§

impl<'t, 'a, 'v> Send for Event<'t, 'a, 'v>

§

impl<'t, 'a, 'v> Sync for Event<'t, 'a, 'v>

§

impl<'t, 'a, 'v> Unpin for Event<'t, 'a, 'v>

§

impl<'t, 'a, 'v> UnsafeUnpin for Event<'t, 'a, 'v>

§

impl<'t, 'a, 'v> UnwindSafe for Event<'t, 'a, 'v>

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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,

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
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>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.