Struct shellfish::Shell

pub struct Shell<T, M: Display, H> {
    pub prompt: M,
    pub commands: HashMap<String, Command<T>>,
    pub state: T,
    pub handler: H,
    pub description: String,
}

A shell represents a shell for editing commands in.

Here are the generics:

• T: The state.
• M: The prompt. Can be anything that can be printed.
• H: The handler. Should implement either Handler or AsyncHandler, or no functionality is present.

Fields

prompt: M

The shell prompt.

It can be anything which implements Display and can therefore be printed (This allows for prompts that change with the state.)

commands: HashMap<String, Command<T>>

This is a list of commands for the shell. The hashmap key is the name of the command (ie "greet") and the value is a wrapper to the function it corresponds to (as well as help information.)

state: T

This is the state of the shell. This stores any values that you need to be persisted over multiple shell commands. For example it may be a simple counter or maybe a session ID.

handler: H

This is the handler for commands. See the Handler documentation for more.

description: String

This is the description of the shell as a whole. This is displayed when requesting help information.

Implementations

impl<T, M: Display> Shell<T, M, DefaultHandler>

pub fn new(state: T, prompt: M) -> Shell<T, M, DefaultHandler>

Creates a new shell

impl<T, M: Display, H: Handler<T>> Shell<T, M, H>

pub fn new_with_handler(state: T, prompt: M, handler: H) -> Self

Creates a new shell with the given handler.

pub fn run(&mut self) -> Result<(), Box<dyn Error>>

Starts running the shell

Trait Implementations

impl<T: Clone, M: Clone + Display, H: Clone> Clone for Shell<T, M, H>

fn clone(&self) -> Shell<T, M, H>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.