Struct VirtualFs 

pub struct VirtualFs { /* private fields */ }

Sandboxed filesystem for a single knowledge base.

All file operations are constrained to the root directory. Path traversal attempts are rejected.

Implementations

impl VirtualFs

pub fn new(root: PathBuf) -> Result<Self>

Create a new VirtualFs rooted at the given directory.

Creates the directory if it doesn’t exist.

pub fn with_quota(self, quota_kb: i64) -> Self

Set a storage quota in kilobytes (0 = unlimited).

pub fn root(&self) -> &Path

Get the root path.

pub fn quota_kb(&self) -> i64

Get the configured quota in KB (0 = unlimited).

pub fn safe_path(&self, dir: &str, filename: &str) -> Result<PathBuf, FsError>

Build a safe absolute path from a directory and filename.

Rejects path traversal attempts (e.g., ../../etc/passwd).

pub fn read_path(&self, path: &str) -> Result<String, FsError>

Read file content by POSIX-style relative path. path examples: “Rust.md”, “brain/Rust.md”, “journal/2024.08 August.md”

pub fn write_path(&self, path: &str, content: &str) -> Result<(), FsError>

Write file content by POSIX-style relative path.

pub fn delete_path(&self, path: &str) -> Result<(), FsError>

Delete file by POSIX-style relative path.

pub fn rename_path(&self, old_path: &str, new_path: &str) -> Result<(), FsError>

Rename/move file by POSIX-style relative paths.

pub fn exists_path(&self, path: &str) -> Result<bool, FsError>

Check if file exists by POSIX-style relative path.

pub fn mtime_path(&self, path: &str) -> Result<i64, FsError>

Get mtime by POSIX-style relative path.

pub fn exists(&self, dir: &str, filename: &str) -> Result<bool, FsError>

Check if a file or directory exists.

pub fn read(&self, dir: &str, filename: &str) -> Result<String, FsError>

Read file contents as a string.

pub fn write( &self, dir: &str, filename: &str, content: &str, ) -> Result<(), FsError>

Write content to a file, creating parent directories as needed.

pub fn read_bytes(&self, dir: &str, filename: &str) -> Result<Vec<u8>, FsError>

Read a file as raw bytes.

pub fn write_bytes( &self, dir: &str, filename: &str, data: &[u8], ) -> Result<(), FsError>

Write raw bytes to a file, creating parent directories as needed. Respects the configured quota (same logic as write()).

pub fn read_path_bytes(&self, path: &str) -> Result<Vec<u8>, FsError>

Read a file by POSIX path as raw bytes.

pub fn write_path_bytes(&self, path: &str, data: &[u8]) -> Result<(), FsError>

Write raw bytes to a file by POSIX path.

pub fn del(&self, dir: &str, filename: &str) -> Result<(), FsError>

Delete a file.

pub fn rename( &self, old_dir: &str, old_filename: &str, new_dir: &str, new_filename: &str, ) -> Result<(), FsError>

Rename/move a file.

pub fn make_dir(&self, dir: &str) -> Result<(), FsError>

Create a directory.

pub fn touch(&self, dir: &str, filename: &str) -> Result<(), FsError>

Touch a file: create if missing, update mtime if present.

pub fn ctime(&self, dir: &str, filename: &str) -> Result<i64, FsError>

Get the ctime/mtime of a file in milliseconds since epoch.

pub fn mtime(&self, dir: &str, filename: &str) -> Result<i64, FsError>

Get the modification time of a file in milliseconds since epoch.

pub fn mtimes( &self, root: &str, extensions: &[&str], ) -> Result<HashMap<String, i64>, FsError>

Recursively collect mtimes for all files with given extensions.

pub fn files_and_dirs(&self, dir: &str) -> Result<Vec<FileEntry>, FsError>

List files and directories in a directory.

pub fn dirs(&self) -> Result<Vec<FileEntry>, FsError>

List only directories in the root.

pub fn is_multiline(&self, dir: &str, filename: &str) -> Result<bool, FsError>

Check if a file has non-whitespace content.

pub fn create_system_dirs(&self) -> Result<(), FsError>

Create the standard system directories (archive, media, journal).

pub fn unhash(&self, dir: &str, filename_hash: &str) -> Result<String, FsError>

Reverse a hash to find the original filename.

pub fn search_files_by_name( &self, query: &str, ) -> Result<Vec<FileEntry>, FsError>

Search files by name across the entire knowledge base.

Trait Implementations

impl Clone for VirtualFs

fn clone(&self) -> VirtualFs

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VirtualFs

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

Formats the value using the given formatter.