Struct Repo

pub struct Repo { /* private fields */ }

Repository

Implementations

impl Repo

pub fn new(directory: impl AsRef<Utf8Path>) -> Result<Self>

Returns an error if the directory doesn’t contain any commit

pub fn directory(&self) -> &Utf8Path

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

Check if there are uncommitted changes.

pub fn checkout_new_branch(&self, branch: &str) -> Result<()>

pub fn delete_branch_in_remote(&self, branch: &str) -> Result<()>

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

pub fn changes(&self, filter: impl FnMut(&&str) -> bool) -> Result<Vec<String>>

Get the list of changed files. filter is applied for each line of git status --porcelain. Only changes for which filter returns true are returned.

pub fn files_of_current_commit(&self) -> Result<HashSet<Utf8PathBuf>>

Get files changed in the current commit

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

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

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

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

pub fn push(&self, obj: &str) -> Result<()>

pub fn fetch(&self, obj: &str) -> Result<()>

pub fn force_push(&self, obj: &str) -> Result<()>

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

pub fn original_branch(&self) -> &str

Branch name before running any git operation. I.e. when the Repo was created.

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

Run a git command in the repository git directory

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

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

Checkout to the latest commit.

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

pub fn checkout(&self, object: &str) -> Result<()>

pub fn add_worktree(&self, path: impl AsRef<str>, object: &str) -> Result<()>

Adds a detached git worktree at the given path checked out at the given object.

pub fn remove_worktree(&self, path: impl AsRef<str>) -> Result<()>

Removes a worktree that was created for this repository at the given path.

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

pub fn get_author_name(&self, commit_hash: &str) -> Result<String>

pub fn get_author_email(&self, commit_hash: &str) -> Result<String>

pub fn get_committer_name(&self, commit_hash: &str) -> Result<String>

pub fn get_committer_email(&self, commit_hash: &str) -> Result<String>

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

Get the SHA1 of the current HEAD.

pub fn tag(&self, name: &str, message: &str) -> Result<String>

Create a git tag

pub fn get_tag_commit(&self, tag: &str) -> Option<String>

Get the commit hash of the given tag

pub fn get_all_tags(&self) -> Vec<String>

Returns all the tags in the repository in an unspecified order.

pub fn is_ancestor( &self, maybe_ancestor_commit: &str, descendant_commit: &str, ) -> bool

Check if a commit comes before another one.

Example

For this git log:

commit d6ec399b80d44bf9c4391e4a9ead8482faa9bffd
commit e880d8786cb16aa9a3f258e7503932445d708df7

git.is_ancestor("e880d8786cb16aa9a3f258e7503932445d708df7", "d6ec399b80d44bf9c4391e4a9ead8482faa9bffd") returns true.

pub fn original_remote(&self) -> &str

Name of the remote when the Repo was created.

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

Url of the remote when the Repo was created.

pub fn tag_exists(&self, tag: &str) -> Result<bool>

pub fn get_branches_of_commit(&self, commit_hash: &str) -> Result<Vec<String>>

Trait Implementations

impl Debug for Repo

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

Formats the value using the given formatter.