Struct ShellState

#[repr(C)]
pub struct ShellState {
    pub header: fn(state: &ShellState) -> String,
    pub history: Vec<String>,
    pub config: Config,
    pub stdin: Stdin,
    pub stdout: RawTerminal<Stdout>,
    /* private fields */
}

The core shell state object. This api is WIP, and may become more locked down in the future.

Fields

header: fn(state: &ShellState) -> String

history: Vec<String>

config: Config

stdin: Stdin

stdout: RawTerminal<Stdout>

Implementations

impl ShellState

pub fn new() -> Result<Self, ZulaError>

Initializes a new shell. Do not use this if making plugins.

pub fn get_cwd(&self) -> &str

Get the current working directory of the shell.

pub fn set_cwd(&mut self, path: &str) -> Result<(), ZulaError>

Set the current working directory of the shell. Will error if the path is not found.

pub fn get_header(&self) -> String

Returns the header or “status bar.”

pub fn exec( &mut self, cmd: impl AsRef<str>, args: &[impl AsRef<str>], ) -> Result<(), ZulaError>

Execute a command. Does no proccessing such as aliases, chaining, and quoting.

pub fn load_plugin(&mut self, path: impl AsRef<OsStr>) -> Result<(), Error>

Attempt to load a plugin from a path.

pub fn plugin_lookup(&self, name: &str) -> Result<&PluginHook, ZulaError>

Returns a hook to the given plugin if it exists.

pub fn plugin_names(&self) -> Keys<'_, String, PluginHook>

Returns an iterator over the currently loaded plugin names.