Struct Repository

pub struct Repository { /* private fields */ }

Available on crate feature git only.

A logical git repository which may or may not exist.

Implementations

impl Repository

pub fn new(dir: impl AsRef<Path>) -> Repository

Create a logical repository from the git worktree dir.

Note the git dir must be .git.

pub fn open(dir: impl AsRef<Path>) -> Result<Repository>

Try to open an existing git repository.

pub fn worktree(&self) -> &Path

Get the path to the worktree of this git repository.

pub fn origin(&self) -> Option<&String>

Get the remote name from which this repository was cloned.

pub fn get_remotes(&self) -> Result<Vec<(String, String)>, CmdError>

Get all remote names and their urls.

pub fn get_default_branch_of(&self, remote: &str) -> Result<String, Error>

Get the default branch name of remote.

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

Get the default branch of this repository’s origin.

Returns None if Self::origin returns None.

pub fn is_clean(&self) -> Result<bool, CmdError>

Query whether the work-tree is clean ignoring any untracked files and recursing through all submodules.

pub fn describe_exact_ref(&self) -> Result<String, CmdError>

Get the exact ref from all refs/ directly referencing the current commit.

E.g.

• branch <branch>: heads/<branch>
• tag <tag>: tags/<tag>

Calls git describe --all --exact-match.

pub fn get_ref(&self) -> Result<Ref, CmdError>

Get a Ref for the current commit.

Calls git describe --all --exact-match --always --abbrev=40

pub fn get_branch_name(&self) -> Result<Option<String>, CmdError>

Get the current branch name if the current checkout is the top of the branch.

pub fn clone(&mut self, url: &str) -> Result<bool, Error>

Clone the repository with the default options and return if the repository was modified.

pub fn is_ref(&self, git_ref: &Ref) -> bool

Whether the repository has currently checked out git_ref.

pub fn is_shallow(&self) -> bool

Whether this repo is a shallow clone.

pub fn clone_ext( &mut self, url: &str, options: CloneOptions, ) -> Result<bool, Error>

Clone the repository with options and return if the repository was modified.

pub fn apply( &self, patches: impl IntoIterator<Item = impl AsRef<OsStr>>, ) -> Result<(), CmdError>

Apply all patches to this repository.

pub fn apply_once( &self, patches: impl Iterator<Item = impl AsRef<OsStr>> + Clone, ) -> Result<(), CmdError>

Apply all patches to this repository only if they were not applied already.

Uses is_applied to determine if the patches were already applied.

pub fn is_applied( &self, patches: impl IntoIterator<Item = impl AsRef<OsStr>>, ) -> Result<bool, CmdError>

Whether all patches are already applied to this repository.

This runs git apply --check --reverse <patches..> which if it succeeds means that git could reverse all patches successfully and implies that all patches were already applied.

Trait Implementations

impl Clone for Repository

fn clone(&self) -> Repository

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Repository

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

Formats the value using the given formatter.