Struct git_shell::Git

pub struct Git { /* private fields */ }

Git

This struct holds a path to some repository. The path does not need to be root directory of that repository.

Implementations

impl Git

pub fn make<P>(path: Option<P>) -> Result<Self> where
    P: AsRef<Path>, 

Makes new instance

If you don’t provide a path, current directory will be used.

pub fn path(&self) -> &Path

Path of this repository

It’s not always the root directory of the repository.

pub fn new_cmd_for_adding_all_files<F, P>(&self, files: Option<F>) -> Command where
    F: Iterator<Item = P>,
    P: AsRef<Path>, 

Makes new command for adding all files

pub fn new_cmd_for_committing_all_files_with_a_message<S>(
    &self,
    msg: S
) -> Command where
    S: AsRef<str>, 

Makes new command for committing all files with a message

pub fn new_cmd_for_adding_an_annotated_tag_with_a_message<S>(
    &self,
    tag: &Semver,
    msg: S
) -> Command where
    S: AsRef<str>, 

Makes new command for adding an annotated tag with a message

pub fn new_cmd_for_pushing_to_a_remote(&self, remote: &Remote) -> Command

Makes new command for pushing to a remote

pub fn new_cmd_for_pushing_tags_to_a_remote(&self, remote: &Remote) -> Command

Makes new command for pushing tags to a remote

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

Loads current branch

pub fn find_last_version_with_build_metadata<I, S>(
    &self,
    build_metadata: I
) -> Result<Option<Semver>> where
    I: Iterator<Item = Option<S>>,
    S: AsRef<str>, 

Finds last version having build metadata in your set

pub fn find_last_versions(&self) -> Result<BTreeMap<Option<String>, Semver>>

Finds last versions, grouped by build metadata

pub fn remotes(&self) -> Result<Vec<Remote>>

Loads remotes and sort them

pub fn work_trees(&self) -> Result<HashSet<WorkTree>>

Loads work trees

pub fn status<F, P>(&self, files: Option<F>) -> Result<HashMap<PathBuf, Status>> where
    F: Iterator<Item = P>,
    P: AsRef<Path>, 

Loads status

Trait Implementations

impl Debug for Git

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

Formats the value using the given formatter.