Struct x_core::git::GitCli

pub struct GitCli { /* private fields */ }

Support for source control operations through running Git commands.

This assumes that the underlying Git repository doesn’t change in the middle of an operation, and caches data as a result. If mutation operations are added, the caches would need to be invalidated.

Implementations

impl GitCli

pub fn new(root: &'static Utf8Path) -> Result<Self>

Creates a new instance of the Git CLI.

pub fn tracked_files(&self) -> Result<&Utf8Paths0>

Returns the files tracked by Git in this working copy.

The return value can be iterated on to get a list of paths.

pub fn merge_base(&self, commit_ref: &str) -> Result<GitHash>

Returns the merge base of the current commit (HEAD) with the specified commit.

pub fn files_changed_between<'a>( &self, old: impl Into<Cow<'a, OsStr>>, new: impl Into<Option<Cow<'a, OsStr>>>, diff_filter: Option<&str> ) -> Result<Utf8Paths0>

Returns the files changed between the given commits, or the current directory if the new commit isn’t specified.

For more about the diff filter, see man git-diff’s help for --diff-filter.

pub fn package_graph_at(&self, commit_ref: &GitHash) -> Result<PackageGraph>

Returns a package graph for the given commit, using a scratch repo if necessary.

pub fn is_git_repo(&self, dir: &Utf8Path) -> Result<bool>

Trait Implementations

impl Clone for GitCli

fn clone(&self) -> GitCli

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GitCli

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

Formats the value using the given formatter.