Struct Repo 

pub struct Repo { /* private fields */ }

A void repository — the primary SDK entry point.

Thread-safe and cheap to clone (internal state is Arc-wrapped).

Implementations

impl Repo

pub fn builder(path: impl AsRef<Path>) -> RepoBuilder

Start building a Repo.

pub fn head(&self) -> Result<CommitInfo>

Get information about the current HEAD commit.

pub fn stream_file(&self, path: &str) -> Result<impl Read + '_>

Stream a file from HEAD. Returns a reader that fetches shards on demand.

pub fn stream_file_at( &self, commit: &CommitId, path: &str, ) -> Result<impl Read + '_>

Stream a file from a specific commit.

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

Read a file fully into memory from HEAD.

pub fn list_dir_at(&self, refstr: &str, path: &str) -> Result<Vec<DirEntry>>

List directory contents from a specific ref (branch, “HEAD”, or CID).

pub fn list_dir(&self, path: &str) -> Result<Vec<DirEntry>>

List directory contents from HEAD.

pub fn status(&self) -> Result<StatusResult>

Compute repository status.

pub fn status_with_options( &self, patterns: Vec<String>, observer: Option<Arc<dyn VoidObserver>>, ) -> Result<StatusResult>

Compute repository status with path patterns and optional observer.

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

Stage files for commit.

pub fn add_with_options( &self, paths: &[&str], observer: Option<Arc<dyn VoidObserver>>, ) -> Result<StageResult>

Stage files with optional progress observer.

pub fn commit(&self, message: &str) -> Result<CommitInfo>

Create a commit from staged changes (or full workspace if no index).

pub fn restore(&self, paths: &[&str]) -> Result<CheckoutStats>

Restore files from HEAD to working tree.

pub fn restore_from( &self, source: &str, paths: &[&str], ) -> Result<CheckoutStats>

Restore files from a specific ref (branch name, “HEAD”, or commit CID).

pub fn restore_from_ref( &self, source: &str, paths: &[&str], force: bool, observer: Option<Arc<dyn VoidObserver>>, ) -> Result<CheckoutStats>

Restore with full options: source ref, force flag, observer.

pub fn reset(&self, paths: &[&str]) -> Result<ResetResult>

Unstage files (reset index entries to match HEAD).

pub fn reset_with_options( &self, paths: &[&str], observer: Option<Arc<dyn VoidObserver>>, ) -> Result<ResetResult>

Unstage files with optional progress observer.

pub fn remove( &self, paths: &[&str], cached_only: bool, force: bool, recursive: bool, ) -> Result<RemoveResult>

Remove files from the index (and optionally working tree).

pub fn mv(&self, source: &str, dest: &str) -> Result<MoveResult>

Move/rename a file in the index and working tree.

pub fn log(&self, limit: usize) -> Result<Vec<CommitInfo>>

Walk commit history from HEAD, most recent first.

Stops gracefully at foreign-repo boundaries (parent commits encrypted with a different key, e.g., fork sources).

pub fn diff(&self) -> Result<TreeDiff>

Diff working tree against HEAD.

pub fn diff_staged(&self) -> Result<TreeDiff>

Diff staged changes against HEAD.

pub fn diff_commits(&self, from: &CommitId, to: &CommitId) -> Result<TreeDiff>

Diff between two commits.

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

List all branches.

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

Create a branch pointing at HEAD.

pub fn branch_at(&self, name: &str, commit: &CommitId) -> Result<()>

Create a branch pointing at a specific commit.

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

Delete a branch.

pub fn switch(&self, name: &str) -> Result<CheckoutStats>

Switch to a branch (checkout its commit).

pub fn push(&self) -> Result<PushResult>

Push commits to a remote store.

Uses the injected remote (daemon) if set via RepoBuilder::remote(), otherwise falls back to IpfsStore from config.

pub fn push_with_options( &self, full: bool, force: bool, observer: Option<Arc<dyn VoidObserver>>, ) -> Result<PushResult>

Push with options: force, full, observer, etc.

pub fn pull(&self, commit_cid: &str) -> Result<PullResult>

Pull a specific commit from a remote store.

Uses the injected remote (daemon) if set, otherwise IpfsStore.

pub fn pull_with_options( &self, commit_cid: &str, mode: CloneMode, observer: Option<Arc<dyn VoidObserver>>, ) -> Result<PullResult>

Pull with options: mode, observer.

pub fn has_remote(&self) -> bool

Check if a remote store is configured.

pub fn add_unixfs(&self, path: &Path) -> Result<AddResult>

Add a directory as a UnixFS DAG to the local object store.

Returns the root CID that IPFS gateways can serve as a website. Equivalent to ipfs add -r <path>.

pub fn add_unixfs_bytes(&self, data: &[u8]) -> Result<FileAddResult>

Add raw bytes as a UnixFS file to the local object store.

Returns detailed info about the added file.

pub fn cat_unixfs(&self, cid: &Cid) -> Result<Vec<u8>>

Read a UnixFS file from the local object store.

Equivalent to ipfs cat <cid>.

pub fn vault(&self) -> &Arc<KeyVault>

Get the vault (for commands that need direct crypto access).

pub fn void_dir(&self) -> &Utf8Path

Get the void directory path.

pub fn root(&self) -> &Utf8Path

Get the workspace root path.

pub fn store(&self) -> Result<FsStore>

Open the object store.

pub fn context(&self) -> &VoidContext

Get the underlying VoidContext.

This is a migration accessor for CLI commands that need direct access to the context while the SDK surface grows. Will be removed as all operations are covered by dedicated SDK methods.

Trait Implementations

impl Clone for Repo

fn clone(&self) -> Repo

Returns a duplicate of the value.

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

Performs copy-assignment from source.