Struct shrust::Shell

pub struct Shell<T> { /* fields omitted */ }

A shell

Methods

impl<T> Shell<T>

pub fn new(data: T) -> Shell<T>

Create a new shell, wrapping data, using provided IO

pub fn data(&mut self) -> &mut T

Get a mutable pointer to the inner data

pub fn set_prompt(&mut self, prompt: String)

Change the current prompt

pub fn set_unclosed_prompt(&mut self, prompt: String)

Change the current unclosed prompt

pub fn set_default<F>(&mut self, func: F) where
    F: Fn(&mut ShellIO, &mut Shell<T>, &str) -> ExecResult + Send + Sync + 'static, 

pub fn new_shell_command<S, F>(
    &mut self,
    name: S,
    description: S,
    nargs: usize,
    func: F
) where
    S: ToString,
    F: Fn(&mut ShellIO, &mut Shell<T>, &[&str]) -> ExecResult + Send + Sync + 'static, 

Register a shell command. Shell commands get called with a reference to the current shell

pub fn new_command<S, F>(
    &mut self,
    name: S,
    description: S,
    nargs: usize,
    func: F
) where
    S: ToString,
    F: Fn(&mut ShellIO, &mut T, &[&str]) -> ExecResult + Send + Sync + 'static, 

Register a command

pub fn new_command_noargs<S, F>(&mut self, name: S, description: S, func: F) where
    S: ToString,
    F: Fn(&mut ShellIO, &mut T) -> ExecResult + Send + Sync + 'static, 

Register a command that do not accept any argument

pub fn print_help(&self, io: &mut ShellIO) -> ExecResult

Print the help to stdout

pub fn get_history(&self) -> &History

Return the command history

pub fn eval(&mut self, io: &mut ShellIO, line: &str) -> ExecResult

Evaluate a command line

pub fn run_loop(&mut self, io: &mut ShellIO)

Enter the shell main loop, exiting only when the "quit" command is called

Trait Implementations

impl<T> Clone for Shell<T> where
    T: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> DerefMut for Shell<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T> Deref for Shell<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.