Struct shrs::ShellConfig

pub struct ShellConfig {
    pub hooks: Hooks,
    pub builtins: Builtins,
    pub readline: Box<dyn Readline>,
    pub alias: Alias,
    pub env: Env,
    pub theme: Theme,
    pub lang: Box<dyn Lang>,
    pub plugins: Vec<Box<dyn Plugin>>,
    pub state: State,
    pub history: Box<dyn History<HistoryItem = String>>,
    pub keybinding: Box<dyn Keybinding>,
}

Unified shell config struct

Fields

hooks: Hooks

Runtime hooks, see Hooks

builtins: Builtins

Builtin shell commands, see Builtins

readline: Box<dyn Readline>

Readline implementation

alias: Alias

Aliases, see Alias

env: Env

Environment variables, see Env

theme: Theme

Color theme

lang: Box<dyn Lang>

Command language

plugins: Vec<Box<dyn Plugin>>

Plugins, see [Plugins]

state: State

Globally accessible state, see State

history: Box<dyn History<HistoryItem = String>>

History, see History

keybinding: Box<dyn Keybinding>

Keybindings, see Keybinding

Implementations

impl ShellConfig

pub fn run(self) -> Result<()>

Start up the shell

This function contains the main loop of the shell and thus will block for the entire execution of the shell.