Struct git_wrapper::Repository

pub struct Repository { /* private fields */ }

The main repository object.

This wrapper allows to keep track of optional git-dir and work-tree directories when executing commands. This functionality was needed for glv & git-stree project.

Implementations

impl Repository

Getters

pub fn is_clean(&self) -> bool

Panics

Panics of executing git-diff(1) fails

pub fn remotes(&self) -> Option<HashMap<String, Remote>>

Returns a HashMap of git remotes

pub fn head(&self) -> String

Returns the HEAD commit id if ref HEAD exists

Panics

Panics when fails to resolve HEAD

pub fn work_tree(&self) -> Option<PathBuf>

Return path to git WORK_TREE

TODO move to generic repo trait TODO Remove optional

pub fn is_sparse(&self) -> bool

Return true if the repo is sparse

pub fn short_ref(&self, long_ref: &str) -> Result<String, InvalidRefError>

Errors

Will return InvalidRefError if invalid reference provided

impl Repository

Constructors

pub fn discover(path: &Path) -> Result<Self, RepoError>

Errors

Will return RepoError when fails to find repository

pub fn default() -> Result<Self, RepoError>

Errors

Will return RepoError when fails to find repository

pub fn create(path: &Path) -> Result<Self, String>

Panics

When git execution fails

Errors

Returns a string output when something goes horrible wrong

pub fn from_args(
    change: Option<&str>,
    git: Option<&str>,
    work: Option<&str>
) -> Result<Self, RepoError>

Errors

Will return RepoError when fails to find repository

impl Repository

Functions

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

Return config value for specified key

Errors

See CommitError

Panics

When git-commit(1) fails to execute

pub fn commit_extended(
    &self,
    message: &str,
    allow_empty: bool,
    no_verify: bool
) -> Result<(), CommitError>

Errors

See CommitError

pub fn hack_read_file(&self, path: &Path) -> Result<Vec<u8>>

Read file from workspace or use git-show(1) if bare repository

Panics

When UTF-8 encoding path fails

Errors

When fails throws std::io::Error TODO move to generic repo trait

pub fn is_ancestor(&self, first: &str, second: &str) -> bool

Returns true if the first commit is an ancestor of the second commit.

pub fn remote_ref_to_id(
    &self,
    remote: &str,
    git_ref: &str
) -> Result<String, RefSearchError>

Errors

See RefSearchError

pub fn sparse_checkout_add(&self, pattern: &str) -> Result<(), String>

Errors

When fails will return a String describing the issue.

Panics

When git-sparse-checkout(1) execution fails

pub fn stage(&self, path: &Path) -> Result<(), StagingError>

Errors

See StagingError

Panics

Panics if fails to execute git-add(1)

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

Stash staged, unstaged and untracked files (keeps ignored files).

Errors

See StashingError

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

Pop stashed changes

Errors

See StashingError

pub fn subtree_add(
    &self,
    url: &str,
    prefix: &str,
    revision: &str,
    message: &str
) -> Result<(), SubtreeAddError>

Errors

Fails if current repo is bare or dirty. In error cases see the provided string.

Panics

When git-subtree(1) execution fails

pub fn subtree_split(&self, prefix: &str) -> Result<(), SubtreeSplitError>

Errors

Fails if current repo is bare or dirty. In error cases see the provided string.

Panics

When git-subtree(1) execution fails

pub fn subtree_pull(
    &self,
    remote: &str,
    prefix: &str,
    git_ref: &str,
    message: &str
) -> Result<(), SubtreePullError>

Errors

Fails if current repo is bare or dirty. In error cases see the provided string.

Panics

When git-subtree(1) execution fails

pub fn subtree_push(
    &self,
    remote: &str,
    prefix: &str,
    git_ref: &str
) -> Result<(), SubtreePushError>

Errors

Fails if current repo is bare. In other error cases see the provided message string.

impl Repository

Commit Functions

pub fn merge_base(
    &self,
    ids: &[&str]
) -> Result<Option<String>, InvalidCommitishError>

Find best common ancestor between to commits.

Errors

Will return InvalidCommitishError::Multiple when one or multiple provided ids do not exist

Panics

When exit code of git-merge-base(1) is not 0 or 128

pub fn git(&self) -> Command

Returns a prepared git Command struct TODO move to generic repo trait

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.