Struct GitRepo 

pub struct GitRepo { /* private fields */ }

A git repository wrapper for parsing commits

Implementations

impl GitRepo

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

Open a git repository at the given path

Errors

Returns GitError::RepositoryNotFound if the path is not a git repository.

pub fn discover(path: impl AsRef<Path>) -> Result<Self, GitError>

Discover and open a git repository containing the given path

This walks up the directory tree to find a .git directory.

Errors

Returns GitError::RepositoryNotFound if no repository is found.

pub fn is_bare(&self) -> bool

Check if the repository is bare

pub fn path(&self) -> &Path

Get the repository path

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

Get the working directory path (None for bare repos)

pub fn walk_commits( &self, options: &WalkOptions, ) -> Result<Vec<CommitWithDiff>, GitError>

Walk commits according to the given options

Errors

Returns GitError if the repository cannot be walked.

pub fn get_commit(&self, reference: &str) -> Result<CommitWithDiff, GitError>

Get a single commit by SHA or reference

Errors

Returns GitError::InvalidReference if the reference cannot be resolved.

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

Get the HEAD commit SHA

Errors

Returns GitError if HEAD cannot be resolved.

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

Count commits in the repository

Errors

Returns GitError if the repository cannot be walked.