Struct clishe::Shell

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

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)

Example

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

Trait Implementations

impl<C, R, A> Clap for Shell<C, R, A> where
    A: Clap + Command<C, R>, 

fn parse() -> Self

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

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

Parse from std::env::args(), 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.

impl<C, R, A> Command<C, R> for Shell<C, R, A> where
    A: Clap + Command<C, R>, 

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

impl<C, R, A> FromArgMatches for Shell<C, R, A> where
    A: Clap + Command<C, R>, 

fn from_arg_matches(_matches: &ArgMatches) -> Self

@TODO @release @docs

impl<C, R, A> IntoApp for Shell<C, R, A> where
    A: Clap + Command<C, R>, 

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

@TODO @release @docs

fn augment_clap<'b>(app: App<'b>) -> App<'b>

@TODO @release @docs