Struct Repository 

pub struct Repository { /* private fields */ }

Implementations

impl Repository

pub fn add<P: AsRef<Path>>(&self, paths: &[P]) -> Result<()>

Add specific files or paths to the staging area.

Arguments

• paths - The file paths to add to the staging area

Returns

A Result indicating success or a GitError if the operation fails.

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

Add all changes to the staging area (equivalent to git add .).

Returns

A Result indicating success or a GitError if the operation fails.

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

Add all tracked files that have been modified (equivalent to git add -u).

Returns

A Result indicating success or a GitError if the operation fails.

impl Repository

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

Create a commit with the given message.

Arguments

• message - The commit message

Returns

A Result containing the Hash of the new commit or a GitError.

pub fn commit_with_author(&self, message: &str, author: &str) -> Result<Hash>

Create a commit with the given message and author.

Arguments

• message - The commit message
• author - The author in format “Name email@example.com”

Returns

A Result containing the Hash of the new commit or a GitError.

impl Repository

pub fn status(&self) -> Result<GitStatus>

Get the status of the repository.

Returns

A Result containing the GitStatus or a GitError.

impl Repository

pub fn ensure_git() -> Result<()>

Ensure that Git is available in the system PATH.

This function checks if the git command is available in the system PATH. The result is cached, so subsequent calls are very fast. If Git is not found, it returns a GitError::CommandFailed with an appropriate error message.

Returns

A Result containing either Ok(()) if Git is available or a GitError.

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

Open an existing Git repository at the specified path.

Arguments

• path - The path to an existing Git repository.

Returns

A Result containing either the opened Repository instance or a GitError.

pub fn init<P: AsRef<Path>>(path: P, bare: bool) -> Result<Self>

Initialize a new Git repository at the specified path.

Arguments

• path - The path where the repository should be initialized.
• bare - Whether the repository should be bare or not.

Returns

A Result containing either the initialized Repository instance or a GitError.

pub fn repo_path(&self) -> &Path

Trait Implementations

impl Debug for Repository

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

Formats the value using the given formatter.