Struct GitVfs 

pub struct GitVfs { /* private fields */ }

Git-aware filesystem backend.

Wraps LocalFs for file operations while tracking git repository state. All file operations go through the local filesystem, with git operations available through dedicated methods.

Implementations

impl GitVfs

pub fn open(path: impl Into<PathBuf>) -> Result<Self, GitError>

Open an existing git repository.

The path should point to a directory containing a .git folder (or the .git folder itself for bare repos).

pub fn clone(url: &str, path: impl Into<PathBuf>) -> Result<Self, GitError>

Clone a repository from a URL.

pub fn init(path: impl Into<PathBuf>) -> Result<Self, GitError>

Initialize a new git repository.

pub fn root(&self) -> &Path

Get the root path of the repository.

pub fn status(&self) -> Result<Vec<FileStatus>, GitError>

Get the current status of the working tree.

pub fn status_summary(&self) -> Result<StatusSummary, GitError>

Get a simplified status summary.

pub fn add(&self, pathspec: &[&str]) -> Result<(), GitError>

Add files to the git index (staging area).

Supports glob patterns (e.g., “.rs”, “src/**/.rs”).

pub fn add_path(&self, path: &Path) -> Result<(), GitError>

Add a specific file to the index.

pub fn reset_path(&self, path: &Path) -> Result<(), GitError>

Remove a file from the index (unstage).

pub fn commit( &self, message: &str, author: Option<&str>, ) -> Result<Oid, GitError>

Create a commit with the staged changes.

pub fn log(&self, count: usize) -> Result<Vec<LogEntry>, GitError>

Get recent commit log entries.

pub fn diff(&self) -> Result<String, GitError>

Get diff between working tree and HEAD.

pub fn current_branch(&self) -> Result<Option<String>, GitError>

Get the current branch name.

pub fn branches(&self) -> Result<Vec<String>, GitError>

List all local branches.

pub fn create_branch(&self, name: &str) -> Result<(), GitError>

Create a new branch.

pub fn checkout(&self, target: &str) -> Result<(), GitError>

Checkout a branch or commit.

If force is true, overwrites local changes. If false, fails if there are uncommitted changes that would be overwritten.

pub fn checkout_with_options( &self, target: &str, force: bool, ) -> Result<(), GitError>

Checkout with explicit force option.

If force is false, checkout will fail if there are uncommitted changes that would be overwritten by the checkout.

pub fn worktrees(&self) -> Result<Vec<WorktreeInfo>, GitError>

List all worktrees attached to this repository.

Returns the main worktree plus any linked worktrees.

pub fn worktree_add( &self, name: &str, path: &Path, committish: Option<&str>, ) -> Result<WorktreeInfo, GitError>

Add a new worktree.

Creates a new worktree at path with the given name.

The committish parameter accepts:

• Local branch names (feature, main)
• Remote tracking branches (origin/main)
• Commit SHAs (abc1234)
• Tags (v1.0.0)
• Any git revision (HEAD~3)

If committish is None, creates a new branch with the worktree name.

pub fn worktree_remove(&self, name: &str, force: bool) -> Result<(), GitError>

Remove a worktree.

The worktree must not be locked and must be prunable (no uncommitted changes). Use force to remove even if it has changes.

pub fn worktree_lock( &self, name: &str, reason: Option<&str>, ) -> Result<(), GitError>

Lock a worktree to prevent it from being pruned.

pub fn worktree_unlock(&self, name: &str) -> Result<(), GitError>

Unlock a worktree.

pub fn worktree_prune(&self) -> Result<usize, GitError>

Prune stale worktree information.

Removes worktree entries that no longer exist on disk.

Trait Implementations

impl Debug for GitVfs

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

Formats the value using the given formatter.

impl Filesystem for GitVfs

fn read<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read the entire contents of a file.

fn write<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 Path, data: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Write data to a file, creating it if it doesn’t exist.

fn list<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<DirEntry>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List entries in a directory.

fn stat<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Metadata>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get metadata for a file or directory.

fn mkdir<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Create a directory (and parent directories if needed).

fn remove<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove a file or empty directory.

fn rename<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Rename (move) a file or directory.

fn read_only(&self) -> bool

Returns true if this filesystem is read-only.

fn exists<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Check if a path exists.

fn real_path(&self, path: &Path) -> Option<PathBuf>

Get the real filesystem path for a VFS path.

fn read_link<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<PathBuf>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read the target of a symbolic link without following it.

fn symlink<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, target: &'life1 Path, link: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create a symbolic link.

fn lstat<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Metadata>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get metadata for a path without following symlinks.