Struct ParseOutput 

pub struct ParseOutput {
    pub cmd: SpecCommand,
    pub cmds: Vec<SpecCommand>,
    pub args: IndexMap<Arc<SpecArg>, ParseValue>,
    pub flags: IndexMap<Arc<SpecFlag>, ParseValue>,
    pub available_flags: BTreeMap<String, Arc<SpecFlag>>,
    pub flag_awaiting_value: Vec<Arc<SpecFlag>>,
    pub errors: Vec<UsageErr>,
    pub next_arg: Option<Arc<SpecArg>>,
    pub double_dash_seen: bool,
}

Fields

cmd: SpecCommand

cmds: Vec<SpecCommand>

args: IndexMap<Arc<SpecArg>, ParseValue>

flags: IndexMap<Arc<SpecFlag>, ParseValue>

available_flags: BTreeMap<String, Arc<SpecFlag>>

Every flag the parser recognizes at this point, keyed by each of its aliases (--long, -s, negations).

This includes flags that only remain recognized because they may appear before a mounted command — see ParseOutput::completion_flags for the set a completion should offer.

flag_awaiting_value: Vec<Arc<SpecFlag>>

errors: Vec<UsageErr>

next_arg: Option<Arc<SpecArg>>

The positional argument the next word would have filled, i.e. where the parser’s cursor stopped. None once every argument is satisfied.

Completions need exactly this: the parser already accounts for var_max, for restart_token rewinds, and for the jump an explicit -- performs onto a double_dash="required" argument, so re-deriving it from args would disagree.

double_dash_seen: bool

Whether an explicit -- was consumed as a separator.

A -- that double_dash="preserve" keeps as a value does not count: it is a value of the variadic argument collecting it, not a separator, so it does not unlock a double_dash="required" argument.

Implementations

impl ParseOutput

pub fn completion_flags(&self) -> BTreeMap<String, Arc<SpecFlag>>

The flags a completion should offer for the parsed command.

Usually every recognized flag, i.e. ParseOutput::available_flags. Once a mounted command has been reached, though, the commands above it belong to the mounting CLI and their flags are not accepted there — mise, for example, forwards everything after a task name to the task itself — so only the flags declared from the mount boundary down are offered. Those globals stay in available_flags because they may legitimately appear before the mounted command.

impl ParseOutput

pub fn as_env(&self) -> BTreeMap<String, String>

Trait Implementations

impl Debug for ParseOutput

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

Formats the value using the given formatter.