Struct Shell 

pub struct Shell { /* private fields */ }

Struct representing the state of the shell, it should be created using Shell::setup() which will handle all necessary initialization such as setting up the REPL editor and loading history from file, and should be used to run the main REPL loop with Shell::run() finally, Shell::exit() should be called before exiting the program to handle any necessary cleanup such as writing history back to file

Example:

fn main() -> clawsh::Result<()> {
    let mut shell = Shell::setup()?;
    shell.run();
    shell.exit()?;
    Ok(())
}

Implementations

impl Shell

pub fn run(&mut self)

Main REPL loop for the shell, continuously reading user input, parsing it, and executing commands until an exit condition is met (e.g. exit command, EOF, or interrupt) internal errors during command handling are printed to stderr but do not exit the shell

impl Shell

pub fn setup() -> Result<Self, ClawshSetupError>

Setup a new Shell instance

Errors

• ClawshSetupError::CreateHistFile if the history file specified by HISTFILE environment variable does not exist and cannot be created
• ClawshSetupError::ReadHistFile if the history file specified by HISTFILE environment variable cannot be read
• ClawshSetupError::CreateEditor if the rustyline::Editor cannot be created for the REPL

pub fn exit(self) -> Result<(), ClawshExitError>

Exit the shell writing history back to file specified by HISTFILE environment variable if it is set if HISTFILE is not set, no history will be written and the function will return Ok(())

Errors

• ClawshExitError::CouldNotOpenHistFile if the history file specified by HISTFILE environment variable cannot be opened for writing during shell exit