Struct GitRepo 

pub struct GitRepo { /* private fields */ }

Represents a Git repository and provides methods for interacting with it.

Implementations

impl GitRepo

pub fn new(repo_path: &Path) -> Result<Self>

Creates a new GitRepo instance from a local path.

Arguments

• repo_path - The path to the Git repository.

Returns

A Result containing the GitRepo instance or an error.

pub fn new_from_url(repository_url: Option<String>) -> Result<Self>

Creates a new GitRepo instance, handling both local and remote repositories.

Arguments

• repository_url - Optional URL for a remote repository.

Returns

A Result containing the GitRepo instance or an error.

pub fn clone_remote_repository(url: &str) -> Result<Self>

Clones a remote repository and creates a GitRepo instance for it.

Arguments

• url - The URL of the remote repository to clone.

Returns

A Result containing the GitRepo instance or an error.

pub fn open_repo(&self) -> Result<Repository, Error>

Open the repository at the stored path

pub fn is_remote(&self) -> bool

Returns whether this GitRepo instance is working with a remote repository

pub fn get_remote_url(&self) -> Option<&str>

Returns the original remote URL if this is a cloned repository

pub fn repo_path(&self) -> &PathBuf

Returns the repository path

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

Updates the remote repository by fetching the latest changes

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

Retrieves the current branch name.

Returns

A Result containing the branch name as a String or an error.

pub fn execute_hook(&self, hook_name: &str) -> Result<()>

Executes a Git hook.

Arguments

• hook_name - The name of the hook to execute.

Returns

A Result indicating success or an error.

pub fn get_repo_root() -> Result<PathBuf>

Get the root directory of the current git repository

pub fn get_readme_at_commit(&self, commit_ish: &str) -> Result<Option<String>>

Retrieves the README content at a specific commit.

Arguments

• commit_ish - A string that resolves to a commit.

Returns

A Result containing an Option with the README content or an error.

pub fn extract_files_info( &self, include_unstaged: bool, ) -> Result<RepoFilesInfo>

Extract files info without crossing async boundaries

pub fn get_unstaged_files(&self) -> Result<Vec<StagedFile>>

Gets unstaged file changes from the repository

pub fn get_ref_diff_full(&self, from: &str, to: &str) -> Result<String>

Get diff between two refs as a full unified diff string with headers

Returns a complete diff suitable for parsing, including:

• diff –git headers
• — and +++ file headers
• @@ hunk headers
• +/- content lines

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

Get staged diff as a full unified diff string with headers

Returns a complete diff suitable for parsing, including:

• diff –git headers
• — and +++ file headers
• @@ hunk headers
• +/- content lines

pub fn get_git_info(&self, _config: &Config) -> Result<CommitContext>

Retrieves Git information for the repository.

Arguments

• config - The configuration object.

Returns

A Result containing the CommitContext or an error.

pub fn get_git_info_with_unstaged( &self, _config: &Config, include_unstaged: bool, ) -> Result<CommitContext>

Get Git information including unstaged changes

Arguments

• config - The configuration object
• include_unstaged - Whether to include unstaged changes

Returns

A Result containing the CommitContext or an error.

pub fn get_git_info_for_branch_diff( &self, _config: &Config, base_branch: &str, target_branch: &str, ) -> Result<CommitContext>

Get Git information for comparing two branches

Arguments

• config - The configuration object
• base_branch - The base branch (e.g., “main”)
• target_branch - The target branch (e.g., “feature-branch”)

Returns

A Result containing the CommitContext for the branch comparison or an error.

pub fn get_git_info_for_commit_range( &self, _config: &Config, from: &str, to: &str, ) -> Result<CommitContext>

Get Git information for a commit range (for PR descriptions)

Arguments

• config - The configuration object
• from - The starting Git reference (exclusive)
• to - The ending Git reference (inclusive)

Returns

A Result containing the CommitContext for the commit range or an error.

pub fn get_commits_for_pr(&self, from: &str, to: &str) -> Result<Vec<String>>

Get commits for PR description between two references

pub fn get_commit_range_files( &self, from: &str, to: &str, ) -> Result<Vec<StagedFile>>

Get files changed in a commit range

pub fn get_recent_commits(&self, count: usize) -> Result<Vec<RecentCommit>>

Retrieves recent commits.

Arguments

• count - The number of recent commits to retrieve.

Returns

A Result containing a Vec of RecentCommit objects or an error.

pub fn commit_and_verify(&self, message: &str) -> Result<CommitResult>

Commits changes and verifies the commit.

Arguments

• message - The commit message.

Returns

A Result containing the CommitResult or an error.

pub fn get_git_info_for_commit( &self, _config: &Config, commit_id: &str, ) -> Result<CommitContext>

Get Git information for a specific commit

Arguments

• config - The configuration object
• commit_id - The ID of the commit to analyze

Returns

A Result containing the CommitContext or an error.

pub fn get_commit_date(&self, commit_ish: &str) -> Result<String>

Get the commit date for a reference

pub fn get_commits_between_with_callback<T, F>( &self, from: &str, to: &str, callback: F, ) -> Result<Vec<T>>

where F: FnMut(&RecentCommit) -> Result<T>,

Get commits between two references with a callback

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

Commit changes to the repository

pub fn amend_commit(&self, message: &str) -> Result<CommitResult>

Amend the previous commit with staged changes and a new message

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

Get the message of the HEAD commit

pub fn is_inside_work_tree() -> Result<bool>

Check if inside a working tree

pub fn get_commit_files(&self, commit_id: &str) -> Result<Vec<StagedFile>>

Get the files changed in a specific commit

pub fn get_file_paths_for_commit(&self, commit_id: &str) -> Result<Vec<String>>

Get just the file paths for a specific commit

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

Stage a file (add to index)

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

Unstage a file (remove from index, keep working tree changes)

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

Stage all modified/new/deleted files

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

Unstage all files (reset index to HEAD)

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

Get list of untracked files (new files not in the index)

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

Get all tracked files in the repository (from HEAD + index)

pub fn get_ahead_behind(&self) -> (usize, usize)

Get ahead/behind counts relative to upstream tracking branch

Returns (ahead, behind) tuple, or (0, 0) if no upstream is configured

Trait Implementations

impl Debug for GitRepo

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

Formats the value using the given formatter.

impl Drop for GitRepo

fn drop(&mut self)

Executes the destructor for this type.