Struct Repository

pub struct Repository { /* private fields */ }

Available on crate feature repo only.

Wrapper for Repository type from git2.

Implementations

impl Repository

pub fn init(path: PathBuf) -> Result<Self>

Initializes (opens) the repository.

pub fn root_path(&self) -> Result<PathBuf>

Returns the path of the repository.

pub fn path(&self) -> &PathBuf

Returns the initial path of the repository.

In case of a submodule this is the relative path to the toplevel repository.

pub fn commits( &self, range: Option<&str>, include_path: Option<Vec<Pattern>>, exclude_path: Option<Vec<Pattern>>, topo_order_commits: bool, ) -> Result<Vec<Commit<'_>>>

Parses and returns the commits.

Sorts the commits by their time.

pub fn submodules_range( &self, old_commit: Option<Commit<'_>>, new_commit: Commit<'_>, ) -> Result<Vec<SubmoduleRange>>

Returns submodule repositories for a given commit range.

For one or two given commits in this repository, a list of changed submodules is calculated. If only one commit is given, then all submodule commits up to the referenced commit will be included. This is usually the case if a submodule is added to the repository.

For each submodule a SubmoduleRange object is created

This can then be used to query the submodule’s commits by using Repository::commits.

pub fn current_tag(&self) -> Option<Tag>

Returns the current tag.

It is the same as running git describe --tags

pub fn resolve_tag(&self, name: &str) -> Tag

Returns the tag object of the given name.

If given name doesn’t exist, it still returns Tag with the given name.

pub fn find_commit(&self, id: &str) -> Option<Commit<'_>>

Returns the commit object of the given ID.

pub fn tags( &self, pattern: &Option<Regex>, topo_order: bool, use_branch_tags: bool, ) -> Result<IndexMap<String, Tag>>

Parses and returns a commit-tag map.

It collects lightweight and annotated tags.

pub fn upstream_remote(&self) -> Result<Remote>

Returns the remote of the upstream repository.

The strategy used here is the following:

Find the branch that HEAD points to, and read the remote configured for that branch returns the remote and the name of the local branch.

Note: HEAD must not be detached.