Struct Git 

pub struct Git { /* private fields */ }

Git subprocess wrapper.

Implementations

impl Git

pub fn new() -> Self

Create a new Git instance using the current directory.

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

Create a new Git instance with a specific working directory.

pub fn work_dir(&self) -> &Path

Get the working directory.

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

Check if we’re in a git repository.

Errors

Returns an error if git is not found or we’re not in a repository.

pub fn repo_root(&self) -> Result<PathBuf, Error>

Get the repository root directory.

Errors

Returns an error if not in a git repository.

pub fn run(&self, args: &[&str]) -> Result<Output, Error>

Run a git command and return the raw output.

Errors

Returns an error if the command fails to execute.

pub fn run_output(&self, args: &[&str]) -> Result<String, Error>

Run a git command and return stdout as a string.

Errors

Returns an error if the command fails or returns non-zero exit code.

pub fn run_silent(&self, args: &[&str]) -> Result<(), Error>

Run a git command silently, only checking for success.

Errors

Returns an error if the command fails.

pub fn head(&self) -> Result<String, Error>

Get the current HEAD commit hash.

Errors

Returns an error if HEAD cannot be resolved.

pub fn short_hash(&self, commit: &str) -> Result<String, Error>

Get a short commit hash.

Errors

Returns an error if the commit cannot be resolved.

pub fn config_get(&self, key: &str) -> Result<Option<String>, Error>

Get a git config value.

Errors

Returns an error if the config key doesn’t exist.

pub fn config_set(&self, key: &str, value: &str) -> Result<(), Error>

Set a git config value.

Errors

Returns an error if the config cannot be set.

pub fn config_unset(&self, key: &str, all: bool) -> Result<(), Error>

Unset a git config value.

If all is true, removes all values for multi-valued keys.

Errors

Returns an error if the config cannot be unset.

pub fn notes_show( &self, notes_ref: &str, commit: &str, ) -> Result<Option<String>, Error>

Get notes content for a commit.

Errors

Returns an error if the notes cannot be read.

pub fn notes_add( &self, notes_ref: &str, commit: &str, content: &str, ) -> Result<(), Error>

Add or update notes for a commit.

Errors

Returns an error if the notes cannot be added.

pub fn notes_remove(&self, notes_ref: &str, commit: &str) -> Result<(), Error>

Remove notes for a commit.

Errors

Returns an error if the notes cannot be removed.

pub fn notes_list( &self, notes_ref: &str, ) -> Result<Vec<(String, String)>, Error>

List all notes in a ref.

Errors

Returns an error if notes cannot be listed.

pub fn notes_push(&self, remote: &str, notes_ref: &str) -> Result<(), Error>

Push notes to a remote.

Errors

Returns an error if push fails.

pub fn notes_fetch(&self, remote: &str, notes_ref: &str) -> Result<(), Error>

Fetch notes from a remote.

Errors

Returns an error if fetch fails.

Trait Implementations

impl Clone for Git

fn clone(&self) -> Git

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Git

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

Formats the value using the given formatter.

impl Default for Git

fn default() -> Self

Returns the “default value” for a type.