Struct GitRepo 

pub struct GitRepo { /* private fields */ }

Git repository operations wrapper.

This struct provides a clean API for common git operations, executing them via std::process::Command internally.

Implementations

impl GitRepo

pub fn new(workdir: impl Into<PathBuf>) -> Self

Create a new GitRepo for the given working directory.

Arguments

• workdir - Path to the git repository working directory

Example

use gba_core::git::GitRepo;

let repo = GitRepo::new("/path/to/repo");

pub fn workdir(&self) -> &Path

Get the working directory path.

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

Get the current branch name.

Errors

Returns an error if the git command fails or if HEAD is detached.

Example

use gba_core::git::GitRepo;

let repo = GitRepo::new(".");
let branch = repo.current_branch()?;
println!("Current branch: {}", branch);

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

Delete a local branch.

Arguments

• name - The branch name to delete
• force - If true, use -D instead of -d for force deletion

Errors

Returns an error if the git command fails.

Example

use gba_core::git::GitRepo;

let repo = GitRepo::new(".");
repo.delete_branch("feature/old-branch", false)?;

pub fn detect_default_branch(&self) -> String

Detect the default branch (main/master) of the repository.

Queries the remote origin to determine the default branch. Falls back to “main” if detection fails.

Example

use gba_core::git::GitRepo;

let repo = GitRepo::new(".");
let default = repo.detect_default_branch();
println!("Default branch: {}", default);

pub fn create_worktree(&self, path: &Path, branch: &str) -> Result<()>

Create a new worktree with a new branch.

Arguments

• path - Path where the worktree should be created
• branch - Name of the new branch to create

Errors

Returns an error if the git command fails.

Example

use std::path::Path;
use gba_core::git::GitRepo;

let repo = GitRepo::new(".");
repo.create_worktree(Path::new(".trees/feature"), "feature/new-feature")?;

pub fn remove_worktree(&self, path: &str, force: bool) -> Result<()>

Remove a worktree.

Arguments

• path - Path of the worktree to remove
• force - If true, force removal even with uncommitted changes

Errors

Returns an error if the git command fails.

Example

use gba_core::git::GitRepo;

let repo = GitRepo::new(".");
repo.remove_worktree(".trees/feature", false)?;

pub fn head_short_sha(&self) -> Result<Option<String>>

Get the short SHA of HEAD.

Returns None if the repository has no commits yet.

Errors

Returns an error if the git command fails for reasons other than an empty repository.

Example

use gba_core::git::GitRepo;

let repo = GitRepo::new(".");
if let Some(sha) = repo.head_short_sha()? {
    println!("Current commit: {}", sha);
}

pub fn add(&self, path: &str) -> Result<()>

Stage a file or path pattern.

Arguments

• path - The file or path pattern to stage (e.g., “.”, “src/”, “*.rs”)

Errors

Returns an error if the git command fails.

Example

use gba_core::git::GitRepo;

let repo = GitRepo::new(".");
repo.add("src/main.rs")?;

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

Create a commit with the given message.

Arguments

• message - The commit message

Errors

Returns an error if the git command fails.

Example

use gba_core::git::GitRepo;

let repo = GitRepo::new(".");
repo.add(".")?;
repo.commit("feat: add new feature")?;

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

Push to origin.

Errors

Returns an error if the git command fails.

Example

use gba_core::git::GitRepo;

let repo = GitRepo::new(".");
repo.push()?;

Trait Implementations

impl Debug for GitRepo

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

Formats the value using the given formatter.