Struct Shell

pub struct Shell {
    pub builtins: Builtins,
    pub lang: Box<dyn Lang>,
    pub keybindings: Keybindings,
    pub hooks: Hooks,
    pub prompt: Prompt,
    pub highlighter: Box<dyn Highlighter>,
    pub suggester: Box<dyn Suggester>,
    pub history: Box<dyn History>,
    /* private fields */
}

Container for shell components

This struct can be queried for in any handler (insert link), allowing for easy access to shell components.

Fields

builtins: Builtins

Builtin shell functions that have access to the shell’s context

lang: Box<dyn Lang>

The command language

keybindings: Keybindings

Shell keybindings

hooks: Hooks

Register new hooks to events or emit an event

prompt: Prompt

Shell prompt

highlighter: Box<dyn Highlighter>

Syntax highlighter

suggester: Box<dyn Suggester>

Active command suggestion

history: Box<dyn History>

Command history

Implementations

impl Shell

pub fn run_cmd<C: Command + 'static>(&self, command: C)

Run an arbitrary shell Command

pub fn run_hooks<C: HookEventMarker>(&self, c: C)

Trigger an event of given type with payload.

See crate::hooks for details.

pub fn eval(&self, cmd_str: impl ToString)

Evaluate an arbitrary command programatically using the shell interpreter

The command will be evaluated as if the user has typed this string in the prompt themselves.

Trait Implementations

impl<'res> Param for &'res Shell

type Item<'new> = &'new Shell

fn retrieve<'r>(shell: &'r Shell, _states: &'r States) -> Result<Self::Item<'r>>