Struct Shell

pub struct Shell<'a> {
    pub stdout: Box<dyn ReadWrite>,
    pub stderr: Box<dyn ReadWrite>,
    /* private fields */
}

A shell for a game.

Fields

stdout: Box<dyn ReadWrite>

stderr: Box<dyn ReadWrite>

Implementations

impl<'a> Shell<'a>

pub fn new() -> Self

pub fn register( &mut self, name: &'a str, invokable: Box<dyn Invokable>, ) -> ShellResult<'_, ()>

Registers a code to Shell. Returns CodeAlreadyExists if the code with provided name already exists in the shell.

pub fn unregister(&mut self, name: &'a str) -> ShellResult<'_, ()>

Unregisters a code from Shell. Returns CodeDoesNotExist if the code with provided name does not exist in the shell.

pub fn filter_names( &'a self, query: &'a str, starts_with: bool, ) -> Box<dyn Iterator<Item = &'a str> + 'a>

Filters names against the query.

• query: The query to filter code names against.
• starts_with: Use starts_with. If false, it uses contains.
• sort: Sort code names alphabetically.

pub fn run(&mut self, input: &'a str)

Invokes commands with given input. You can read from a file. The unregistered codes are simply passed.