Struct FileSystem 

pub struct FileSystem { /* private fields */ }

Main filesystem interface for Heroforge repositories

This provides a filesystem-like API over the Heroforge repository storage. All operations are atomic and maintain version history.

Thread Safety

FileSystem is thread-safe. Multiple threads can read simultaneously, but writes are serialized through an internal mutex.

Example

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

fn main() -> heroforge_core::Result<()> {
    let repo = Arc::new(Repository::open_rw("project.forge")?);
    let fs = FileSystem::new(repo);

    // Read without commit
    let exists = fs.exists("README.md")?;
    if !exists {
        // Write with auto-commit
        fs.write_file("README.md", b"# My Project", "admin", "Initialize README")?;
    }

    Ok(())
}

Implementations

impl FileSystem

pub fn new(repo: Arc<Repository>) -> Self

Create a new filesystem interface for a repository

pub fn status(&self) -> FileSystemStatus

Get current status

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

Check if a path exists

Arguments

• path - Path to check (relative to repository root)

Returns

true if path exists, false otherwise

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

Check if path is a directory

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

Check if path is a file

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

Get file metadata

Arguments

• path - Path to file/directory

Returns

File metadata including size, permissions, etc.

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

Read file content as bytes

Arguments

• path - Path to file

Returns

File content as Vec<u8>

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

Read file content as string

Arguments

• path - Path to file

Returns

File content as String

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

List directory contents

Arguments

• path - Directory path

Returns

Vector of directory entries

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

Write file content (creates or overwrites)

Arguments

• path - Path to file
• content - File content
• author - Author name
• message - Commit message

Returns

Commit hash of the change

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

Copy a file

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

Copy a directory recursively

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

Move/rename a file

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

Move/rename a directory

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

Delete a file

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

Delete a directory recursively

pub fn chmod( &self, path: &str, permissions: FilePermissions, author: &str, message: &str, ) -> FsResult<String>

Change file permissions

pub fn chmod_recursive( &self, path: &str, permissions: FilePermissions, author: &str, message: &str, ) -> FsResult<String>

Change permissions recursively

pub fn make_executable( &self, path: &str, author: &str, message: &str, ) -> FsResult<String>

Make file executable

pub fn symlink( &self, link_path: &str, target_path: &str, author: &str, message: &str, ) -> FsResult<String>

Create a symbolic link

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

Find files matching a glob pattern

Arguments

• pattern - Glob pattern (e.g., “**/*.rs”)

Returns

List of matching file paths

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

Calculate disk usage of a path

Arguments

• path - Path to directory or file

Returns

Total size in bytes

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

Count files matching a pattern

Arguments

• pattern - Glob pattern

Returns

Number of matching files

pub fn begin_transaction(&self) -> FsResult<Transaction>

Begin a transaction for batch operations

Returns

A transaction that can be used to group multiple operations

pub fn end_transaction(&self) -> FsResult<()>

End the active transaction

pub fn has_active_transaction(&self) -> bool

Check if a transaction is active

pub fn active_transaction(&self) -> Option<Transaction>

Get the active transaction (if any)

Trait Implementations

impl Clone for FileSystem

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.