Struct ReadWriteFs 

pub struct ReadWriteFs { /* private fields */ }

A passthrough filesystem backed by std::fs.

With no root restriction, all operations delegate directly to the real filesystem. When a root is set, paths are confined to the subtree under that root — acting like a lightweight chroot.

Example

use rust_bash::{RustBashBuilder, ReadWriteFs};
use std::sync::Arc;

let rwfs = ReadWriteFs::with_root("/tmp/sandbox").unwrap();
let mut shell = RustBashBuilder::new()
    .fs(Arc::new(rwfs))
    .cwd("/")
    .build()
    .unwrap();

shell.exec("echo hello > /output.txt").unwrap(); // writes to /tmp/sandbox/output.txt

Implementations

impl ReadWriteFs

pub fn new() -> Self

Create a ReadWriteFs with unrestricted access to the real filesystem.

pub fn with_root(root: impl Into<PathBuf>) -> Result<Self>

Create a ReadWriteFs restricted to paths under root.

All paths are resolved relative to root. Path traversal beyond root (via .. or symlinks) is rejected with PermissionDenied. The root directory must exist and is canonicalized on construction.

Trait Implementations

impl Default for ReadWriteFs

fn default() -> Self

Returns the “default value” for a type.

impl VirtualFs for ReadWriteFs

fn read_file(&self, path: &Path) -> Result<Vec<u8>, VfsError>

fn write_file(&self, path: &Path, content: &[u8]) -> Result<(), VfsError>

fn append_file(&self, path: &Path, content: &[u8]) -> Result<(), VfsError>

fn remove_file(&self, path: &Path) -> Result<(), VfsError>

fn mkdir(&self, path: &Path) -> Result<(), VfsError>

fn mkdir_p(&self, path: &Path) -> Result<(), VfsError>

fn readdir(&self, path: &Path) -> Result<Vec<DirEntry>, VfsError>

fn remove_dir(&self, path: &Path) -> Result<(), VfsError>

fn remove_dir_all(&self, path: &Path) -> Result<(), VfsError>

fn exists(&self, path: &Path) -> bool

fn stat(&self, path: &Path) -> Result<Metadata, VfsError>

fn lstat(&self, path: &Path) -> Result<Metadata, VfsError>

fn chmod(&self, path: &Path, mode: u32) -> Result<(), VfsError>

fn utimes(&self, path: &Path, mtime: SystemTime) -> Result<(), VfsError>

fn symlink(&self, target: &Path, link: &Path) -> Result<(), VfsError>

fn hardlink(&self, src: &Path, dst: &Path) -> Result<(), VfsError>

fn readlink(&self, path: &Path) -> Result<PathBuf, VfsError>

fn canonicalize(&self, path: &Path) -> Result<PathBuf, VfsError>

fn copy(&self, src: &Path, dst: &Path) -> Result<(), VfsError>

fn rename(&self, src: &Path, dst: &Path) -> Result<(), VfsError>

fn glob(&self, pattern: &str, cwd: &Path) -> Result<Vec<PathBuf>, VfsError>

fn deep_clone(&self) -> Arc<dyn VirtualFs>

Create an independent deep copy for subshell isolation.

fn glob_with_opts( &self, pattern: &str, cwd: &Path, _opts: &GlobOptions, ) -> Result<Vec<PathBuf>, VfsError>

Glob expansion with shopt-controlled options (dotglob, nocaseglob, globstar).