Enum TokenRole 

#[non_exhaustive]
pub enum TokenRole {
    Program,
    Command {
        name: String,
    },
    Flag {
        flag: Arc<SpecFlag>,
        spelling: String,
        negated: bool,
    },
    Value {
        flag: Arc<SpecFlag>,
        values: Vec<String>,
        attached: bool,
    },
    Arg {
        arg: Arc<SpecArg>,
        values: Vec<String>,
    },
    Separator,
    Builtin {
        spelling: String,
    },
    ValueTerminator {
        ends: String,
    },
    Restart,
    UnknownFlag {
        bound_as: Option<Arc<SpecArg>>,
    },
    Refused {
        reason: String,
    },
    External,
    Unread,
}

What one word of the command line became.

Several because a single token can do more than one thing: -abc sets three flags, -j8 is a flag and its value.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Program

argv[0]. Also a Command when a multicall symlink makes the basename a word.

Command

Selected a subcommand.

Fields

name: String

Flag

Named a flag, in this spelling. negated for the negate form.

Fields

flag: Arc<SpecFlag>

spelling: String

negated: bool

Value

Supplied a flag’s value. Several values when a delimiter split the word.

Fields

flag: Arc<SpecFlag>

values: Vec<String>

attached: bool

Whether the value rode along on the flag’s own token (--env=prod, -j8) rather than following it as its own word.

Arg

Filled a positional argument. Several values when a delimiter split the word.

Fields

arg: Arc<SpecArg>

values: Vec<String>

Separator

An explicit --, consumed as a separator.

Builtin

A word the parser answers itself rather than binding: --help, -h, --version, -V. The parse stops here and the answer travels as an error carrying the text, so without a role the word reads as having done nothing while a whole help page arrives in the error list.

Fields

spelling: String

ValueTerminator

A declared value_terminator, consumed to end a run of values. ends names the declaration whose run it closed — the word is not one of that run’s values, which is the whole reason it was declared.

Fields

ends: String

Restart

A declared restart_token: the positional cursor and the values it had filled start over here. Recorded because the words before it are still in the report, and without this row they look like they filled arguments that then came back empty.

UnknownFlag

A flag-like word no declaration matched. bound_as is the positional that took it under unknown_flags="value", and None when the word was refused.

Fields

bound_as: Option<Arc<SpecArg>>

Refused

The word reached a declaration that would not take it, and was dropped. Without this the token reads as having done nothing, which is the one thing it did not do.

Fields

reason: String

External

Forwarded to an external subcommand.

Unread

The parser stopped before this word — a help request, a refused value.

Trait Implementations

impl Clone for TokenRole

fn clone(&self) -> TokenRole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenRole

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

Formats the value using the given formatter.