Struct cmdmat::Mapping

pub struct Mapping<'a, A, D, C> { /* fields omitted */ }

Node in the matching tree

A Mapping is used to interface with cmdmat. Each node defines a point in a command tree, containing subcommands, deciders for argument parsing, and a finalizer if this mapping can be run.

Methods

impl<'a, A, D, C> Mapping<'a, A, D, C>

pub fn register_many<'b>(
    &mut self,
    spec: &[Spec<'b, 'a, A, D, C>]
) -> Result<(), RegError>

Register many command specs at once, see Mapping::register for more detail

pub fn register<'b>(
    &mut self,
    spec: Spec<'b, 'a, A, D, C>
) -> Result<(), RegError>

Register a single command specification into the tree

The specification will be merged with existing command specifications, and may not overwrite commands with new deciders or finalizers. The overriding decider must be None to avoid an error.

pub fn lookup(&self, input: &[&str]) -> Result<FinWithArgs<A, C>, LookError<D>>

Looks up a command and runs deciders to collect all arguments

pub fn get_direct_keys(&self) -> impl Iterator<Item = MappingEntry<A, D, C>>

Iterator over the current Mapping keys: containing subcommands

pub fn partial_lookup<'b>(
    &'b self,
    input: &'b [&str]
) -> Result<MapOrDesc<'a, 'b, A, D, C>, LookError<D>>

Acquire any intermediate mapping, discards parsed inputs

pub fn decider(&self) -> &Option<&'a Decider<A, D>>

Get the decider associated with this node

pub fn finalizer(&self) -> &Option<Finalizer<A, C>>

Get the finalizer associated with this node

pub fn iter(&self) -> impl Iterator<Item = (&&'a str, &Mapping<'a, A, D, C>)>

Iterator looping over all submappings

Trait Implementations

impl<'a, A, D, C> Default for Mapping<'a, A, D, C>

fn default() -> Self

Returns the "default value" for a type.