Struct Shell 

pub struct Shell<C, R, A: Parser + Command<C, R>> { /* private fields */ }

A command that spawns a shell of the provided dispatcher type.

The shell command spawns a shell using rustyline and shellwords libraries. The type arguments it takes are straightforward:

• Context type (state)
• Return type (same as command hierarchy)
• Dispatcher to create a shell for (can be self-referential)

This object is only built if you set the shell feature while importing:

clishe = { version = "^0", features = ["shell"] }

Example

dispatchers! {
    Food(self, _: &mut u64) -> Result<()> [
        Shell: clishe::Shell<u64, (), Food>,
    ],
}

Trait Implementations

impl<C, R, A> Args for Shell<C, R, A>

where A: Parser + Command<C, R>,

fn augment_args<'b>(cmd: Command<'b>) -> Command<'b>

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(cmd: Command<'b>) -> Command<'b>

Append to Command so it can update self.

impl<C, R, A> Command<C, R> for Shell<C, R, A>

where A: Parser + Command<C, R>,

fn run(self, ctx: &mut C) -> Result<R>

impl<C, R, A> CommandFactory for Shell<C, R, A>

where A: Parser + Command<C, R>,

fn into_app<'b>() -> App<'b>

Deprecated, replaced with CommandFactory::command

fn into_app_for_update<'b>() -> App<'b>

Deprecated, replaced with CommandFactory::command_for_update

fn command<'help>() -> App<'help>

Build a Command that can instantiate Self.

fn command_for_update<'help>() -> App<'help>

Build a Command that can update self.

impl<C, R, A> FromArgMatches for Shell<C, R, A>

where A: Parser + Command<C, R>,

fn from_arg_matches(_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, _matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn from_arg_matches_mut(matches: &mut ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches_mut( &mut self, matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl<C, R, A> Parser for Shell<C, R, A>

where A: Parser + Command<C, R>,

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.