Struct Repository 

pub struct Repository { /* private fields */ }

High-level wrapper around a git repository.

Implementations

impl Repository

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

Open a repository at the given path.

Errors

Returns error if no repository found at path or any parent.

pub fn open_current() -> Result<Self>

Open the repository containing the current directory.

Errors

Returns error if not inside a git repository.

pub fn workdir(&self) -> Option<&Path>

Get the path to the repository root (workdir).

pub fn git_dir(&self) -> &Path

Get the path to the .git directory.

pub fn state(&self) -> RepositoryState

Get the current repository state.

pub fn is_rebasing(&self) -> bool

Check if there’s a rebase in progress.

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

Get the name of the current branch.

Errors

Returns error if HEAD is detached.

pub fn branch_commit(&self, branch_name: &str) -> Result<Oid>

Get the commit SHA for a branch.

Errors

Returns error if branch doesn’t exist.

pub fn remote_branch_commit(&self, branch_name: &str) -> Result<Oid>

Get the commit ID of a remote branch tip.

Errors

Returns error if branch not found.

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

Create a new branch at the current HEAD.

Errors

Returns error if branch creation fails.

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

Checkout a branch.

Errors

Returns error if checkout fails.

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

List all local branches.

Errors

Returns error if branch listing fails.

pub fn branch_exists(&self, name: &str) -> bool

Check if a branch exists.

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

Delete a local branch.

Errors

Returns error if branch deletion fails.

pub fn is_clean(&self) -> Result<bool>

Check if the working directory is clean (no modified or staged files).

Untracked files are ignored - only tracked files that have been modified or staged count as “dirty”.

Errors

Returns error if status check fails.

pub fn require_clean(&self) -> Result<()>

Ensure working directory is clean, returning error if not.

Errors

Returns DirtyWorkingDirectory if there are uncommitted changes.

pub fn find_commit(&self, oid: Oid) -> Result<Commit<'_>>

Get a commit by its SHA.

Errors

Returns error if commit not found.

pub fn merge_base(&self, one: Oid, two: Oid) -> Result<Oid>

Get the merge base between two commits.

Errors

Returns error if merge base calculation fails.

pub fn count_commits_between(&self, from: Oid, to: Oid) -> Result<usize>

Count commits between two points.

Errors

Returns error if revwalk fails.

pub fn reset_branch(&self, branch_name: &str, target: Oid) -> Result<()>

Hard reset a branch to a specific commit.

Errors

Returns error if reset fails.

pub fn signature(&self) -> Result<Signature<'_>>

Get the default signature for commits.

Errors

Returns error if git config doesn’t have user.name/email.

pub fn rebase_onto(&self, target: Oid) -> Result<()>

Rebase the current branch onto a target commit.

Returns Ok(()) on success, or Err(RebaseConflict) if there are conflicts.

Errors

Returns error if rebase fails or conflicts occur.

pub fn rebase_onto_from(&self, new_base: Oid, old_base: Oid) -> Result<()>

Rebase the current branch onto a new base, replaying only commits after old_base.

This is equivalent to git rebase --onto <new_base> <old_base>. Use this when the old_base was squash-merged and you want to bring only the unique commits from the current branch.

Errors

Returns error if rebase fails or conflicts occur.

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

Get list of files with conflicts.

Errors

Returns error if status check fails.

pub fn rebase_abort(&self) -> Result<()>

Abort an in-progress rebase.

Errors

Returns error if abort fails.

pub fn rebase_continue(&self) -> Result<()>

Continue an in-progress rebase.

Errors

Returns error if continue fails or new conflicts occur.

pub fn origin_url(&self) -> Result<String>

Get the URL of the origin remote.

Errors

Returns error if origin remote is not found.

pub fn parse_github_remote(url: &str) -> Result<(String, String)>

Parse owner and repo name from a GitHub URL.

Supports both HTTPS and SSH URLs:

• https://github.com/owner/repo.git
• git@github.com:owner/repo.git

Errors

Returns error if URL cannot be parsed.

pub fn push(&self, branch: &str, force: bool) -> Result<()>

Push a branch to the remote.

Errors

Returns error if push fails.

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

Fetch a branch from origin.

Errors

Returns error if fetch fails.

pub fn pull_ff(&self) -> Result<()>

Pull (fast-forward only) the current branch from origin.

This fetches and merges origin/<branch> into the current branch, but only if it can be fast-forwarded.

Errors

Returns error if pull fails or fast-forward is not possible.

pub const fn inner(&self) -> &Repository

Get a reference to the underlying git2 repository.

Use sparingly - prefer high-level methods.

Trait Implementations

impl Debug for Repository

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

Formats the value using the given formatter.