Struct Parser 

pub struct Parser<S, C, E: Event<State = S>> { /* private fields */ }

Parser for EventProxy of some event type.

Implementations

impl<S, C, E> Parser<S, C, E>

where E: Event<State = S> + FromStr + StaticNamed,

pub fn new( shorthand: Option<Cow<'static, str>>, description: Description, ) -> Self

Creates a new parser. The name is taken from the event type, provided the latter implements StaticNamed.

Trait Implementations

impl<S: 'static, C: Context<State = S> + 'static, E, T: Terminal> NamedCommandParser<T> for Parser<S, C, E>

where E: FromStr + Event<State = S> + 'static, E::Err: ToString,

type Context = C

The application context type. (The part of the application this is not the REPL library.)

type Error = SimulationError<S>

The type of error that can be produced by the execution of the command.

fn parse( &self, s: &str, ) -> Result<Box<dyn Command<T, Context = C, Error = SimulationError<S>>>, ParseCommandError>

Parses the given string slice, returning Command object.

fn shorthand(&self) -> Option<Cow<'static, str>>

Optional shorthand moniker for the command. The user may type in this string instead of the full command name.

fn name(&self) -> Cow<'static, str>

The (mandatory) complete name of the command. The user will type in the name of the command, followed by some (depending on the command) arguments.

fn description(&self) -> Description

Describes the command. The description is displayed when invoking the help command.

fn parse_no_args<M>( &self, s: &str, ctor: impl FnOnce() -> M, ) -> Result<Box<dyn Command<T, Error = Self::Error, Context = Self::Context>>, ParseCommandError>

where M: Command<T, Context = Self::Context, Error = Self::Error> + 'static, T: Terminal, Self: Sized,

A convenience method for creating a Command object by invoking the given ctor closure, assuming that this command does not require any arguments.