Struct FsInterface 

pub struct FsInterface { /* private fields */ }

High-level filesystem interface with staging support.

This is the recommended way to interact with Heroforge repositories for filesystem-like operations. It provides:

• Fast writes via staging directory
• Layered reads (staging → database)
• Automatic background commits
• Partial file updates (read-modify-write)
• Thread-safe operations via RwLock

Implementations

impl FsInterface

pub fn new(repo: Arc<Repository>, author: &str) -> FsResult<Self>

Create a new FsInterface for a repository.

Arguments

• repo - The repository to operate on
• author - Author name for all commits from this interface

Example

use heroforge_core::Repository;
use heroforge_core::fs::FsInterface;
use std::sync::Arc;

let repo = Arc::new(Repository::open_rw("project.forge")?);
let fs = FsInterface::new(repo, "developer@example.com")?;

pub fn with_config( repo: Arc<Repository>, author: &str, config: CommitConfig, ) -> FsResult<Self>

Create a new FsInterface with custom configuration.

pub fn without_timer(repo: Arc<Repository>, author: &str) -> FsResult<Self>

Create a new FsInterface without background commit timer. Useful for testing or manual commit control.

pub fn status(&self) -> FsInterfaceStatus

Get the current status

pub fn author(&self) -> String

Get the author name

pub fn branch(&self) -> &str

Get the current branch

pub fn has_changes(&self) -> bool

Check if there are uncommitted changes

pub fn exists(&self, path: &str) -> FsResult<bool>

Check if a path exists (in staging or database).

pub fn is_dir(&self, path: &str) -> FsResult<bool>

Check if a path is a directory.

pub fn is_file(&self, path: &str) -> FsResult<bool>

Check if a path is a file.

pub fn stat(&self, path: &str) -> FsResult<FileMetadata>

Get file metadata.

pub fn read_file(&self, path: &str) -> FsResult<Vec<u8>>

Read file content as bytes.

Checks staging directory first, then falls back to database.

pub fn read_file_string(&self, path: &str) -> FsResult<String>

Read file content as string.

pub fn list_dir(&self, path: &str) -> FsResult<Vec<DirectoryEntry>>

List directory contents.

pub fn find(&self, pattern: &str) -> FsResult<FindResults>

Find files matching a glob pattern.

pub fn disk_usage(&self, path: &str) -> FsResult<u64>

Calculate disk usage of a path.

pub fn count_files(&self, pattern: &str) -> FsResult<usize>

Count files matching a pattern.

pub fn write_file(&self, path: &str, content: &[u8]) -> FsResult<()>

Write file content.

The file is written to the staging directory immediately. It will be committed to the database during the next auto-commit or when commit() is called.

pub fn write_file_string(&self, path: &str, content: &str) -> FsResult<()>

Write file content from a string.

pub fn write_at(&self, path: &str, offset: u64, data: &[u8]) -> FsResult<()>

Write at a specific offset in a file (partial update).

If the file exists only in the database, it will be promoted to staging first. This implements the read-modify-write pattern described in the spec.

pub fn delete_file(&self, path: &str) -> FsResult<()>

Delete a file.

pub fn delete_dir(&self, path: &str) -> FsResult<()>

Delete a directory recursively.

pub fn copy_file(&self, src: &str, dst: &str) -> FsResult<()>

Copy a file.

pub fn move_file(&self, src: &str, dst: &str) -> FsResult<()>

Move a file.

pub fn copy_dir(&self, src: &str, dst: &str) -> FsResult<()>

Copy a directory recursively.

pub fn move_dir(&self, src: &str, dst: &str) -> FsResult<()>

Move a directory recursively.

pub fn commit(&self) -> FsResult<String>

Force an immediate commit of all staged changes.

Returns the commit hash, or “no-changes” if nothing was staged.

pub fn commit_with_message(&self, message: &str) -> FsResult<String>

Force a commit with a custom message.

pub fn switch_branch(&mut self, branch: &str) -> FsResult<()>

Switch to a different branch.

Forces a commit of any staged changes before switching.

Trait Implementations

impl Drop for FsInterface

fn drop(&mut self)

Executes the destructor for this type.