Struct Shell 

pub struct Shell { /* private fields */ }

A virtual Bash environment.

Create one with Shell::new for defaults or Shell::builder for full control. The filesystem persists across exec calls; shell state (variables, functions, cwd) is isolated per call.

Implementations

impl Shell

pub fn new() -> Self

Create an instance with default settings and an empty in-memory filesystem.

pub fn builder() -> Builder

Start building a configured instance.

pub fn exec(&mut self, command: &str) -> Result<ExecResult, Error>

Execute a bash command string.

Shell state (variables, functions, working directory) is isolated per call - each invocation starts fresh. The filesystem is shared and persists across calls.

Errors

Returns Error::Parse for syntax errors, Error::LimitExceeded if an execution limit is hit. Note that a non-zero exit code is not an error - it’s reported in ExecResult::exit_code.

pub fn exec_with( &mut self, command: &str, options: ExecOptions<'_>, ) -> Result<ExecResult, Error>

Execute with custom options (stdin, env overrides, cwd override).

pub fn register_command(&mut self, name: impl Into<String>, func: CommandFn)

Register a custom command after construction.

pub fn exec_with_timeout( &mut self, command: &str, timeout: Duration, ) -> Result<ExecResult, Error>

Execute a command with a timeout. Spawns a timer thread that cancels execution after the given duration.

pub fn fs(&self) -> &dyn VirtualFs

Direct access to the virtual filesystem.

pub fn read_file(&self, path: &str) -> Result<String, Error>

Read a file as a UTF-8 string.

pub fn write_file(&self, path: &str, content: &str) -> Result<(), Error>

Write a UTF-8 string to a file (creates parent directories).

pub fn cwd(&self) -> &str

Current working directory.

pub fn env(&self) -> &HashMap<String, String>

Current default environment variables.

Trait Implementations

impl Debug for Shell

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Shell

fn default() -> Self

Returns the “default value” for a type.