Struct Repo 

pub struct Repo { /* private fields */ }

A repository handle. Cheap to clone — every field is either Arc-wrapped (the gix handle) or a small owned value.

Repo is Send + Sync; method clones across tokio::spawn are fine. See module-level docs for the wider design.

Implementations

impl Repo

pub async fn blame( &self, path: &Path, revspec: &str, ) -> Result<Blame, RepoError>

Compute per-line blame for path at revspec.

Errors

• RepoError::RevspecNotFound — revspec did not resolve, or path does not exist at the resolved commit.
• RepoError::WalkFailed — gix-blame encountered an internal error (object-store I/O, commit graph traversal).

impl Repo

pub async fn checkout( &self, revspec: &str, opts: CheckoutOptions, ) -> Result<(), RepoError>

Switch the working tree to revspec.

Refuses by default if the working tree has unstaged modifications to tracked files — surfaced as RepoError::DirtyWorkingTree with the offending paths. Pass CheckoutOptions::force(true) to override.

Errors

• RepoError::DirtyWorkingTree — dirty tree, force = false.
• RepoError::RevspecNotFound — revspec did not resolve.
• RepoError::CheckoutFailed — git checkout returned non-zero for some other reason.

impl Repo

pub async fn clone( url: &str, dst: impl AsRef<Path>, opts: CloneOptions, ) -> Result<Self, RepoError>

Clone url into dst.

Anonymous clones (no credential on opts) run through gix directly. Authenticated clones shell out to git with the resolved token in process env (never argv).

dst must not exist or must be an empty directory.

Errors

• RepoError::CloneFailed — gix or git could not fetch refs, download objects, or check out the working tree.
• RepoError::Auth — opts.credential could not be resolved.

impl Repo

pub async fn commit( &self, paths: &[&Path], message: &str, ) -> Result<String, RepoError>

Stage paths and create a commit on HEAD with message.

Paths are interpreted relative to the repository’s working tree. Paths that exist on disk are staged as modifications or additions; paths that don’t exist (e.g. just deleted) are staged as deletions. This matches git add <paths> semantics.

Returns the new commit’s OID as a 40-character hex string.

Errors

• RepoError::CommitFailed — empty paths, git not on PATH, no author / committer configured, or any other underlying git add / git commit failure. The cause field carries the underlying error message.

impl Repo

pub async fn diff(&self, a: &str, b: &str) -> Result<Diff, RepoError>

Diff two tree-ish references (e.g. HEAD~1 vs HEAD).

Errors

• RepoError::RevspecNotFound — either a or b could not be resolved.
• RepoError::DiffFailed — gix could not read the trees or compute the diff.

impl Repo

pub async fn fetch( &self, remote: &str, opts: FetchOptions, ) -> Result<(), RepoError>

Fetch from remote, updating remote-tracking refs but not touching the working tree or local branches.

Errors

• RepoError::FetchFailed — git fetch returned non-zero.
• RepoError::Auth — opts.credential could not be resolved.

impl Repo

pub async fn init( path: impl AsRef<Path>, _opts: InitOptions, ) -> Result<Self, RepoError>

Initialise a new repository at path. The directory is created if it doesn’t already exist (mirroring git init <path> semantics).

Errors

• RepoError::InitFailed — gix could not create the repository (filesystem permission, an existing repository that conflicts, etc.). cause carries the backend’s stringified error.

impl Repo

pub async fn push( &self, remote: &str, refspec: &str, opts: PushOptions, ) -> Result<(), RepoError>

Push refspec to remote.

Errors

• RepoError::PushFailed — git push returned non-zero (unknown remote, network failure, non-fast-forward).
• RepoError::Auth — opts.credential could not be resolved.

impl Repo

pub async fn status(&self) -> Result<RepoStatus, RepoError>

Compute the working-tree status.

Errors

• RepoError::StatusFailed — gix could not iterate the status (permission errors, malformed index, etc.). cause carries the backend’s stringified error.

impl Repo

pub fn walk(&self, revspec: &str) -> Result<CommitWalk, RepoError>

Walk the commit graph from revspec.

Supports Include (HEAD), Range (A..B), and Merge (A...B) revspecs. The remaining gix-revision kinds (IncludeOnlyParents, ExcludeParents, etc.) are reported as RepoError::WalkFailed — they’re rare and we add support when a real consumer asks.

Errors

• RepoError::RevspecNotFound — revspec did not resolve.
• RepoError::WalkFailed — gix could not initialise the walk, or revspec is a kind we don’t yet support.

Errors during walking (individual commits) are surfaced in-band on the returned stream.

impl Repo

pub async fn open(path: impl AsRef<Path>) -> Result<Self, RepoError>

Open an existing repository at path. Discovers .git if path is a subdirectory of a working tree (matches git’s own discovery rules).

Errors

• RepoError::OpenFailed — the path does not contain a repository (or gix cannot read it). cause carries the backend’s stringified error.

pub fn path(&self) -> &Path

The on-disk path this Repo was opened / initialised from. Stable across the lifetime of the handle.

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.

impl Debug for Repo

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

Formats the value using the given formatter.