Enum GitError 

pub enum GitError {
    NotAGitRepository(String, String),
    NoHead,
    NotOnABranch,
    NoRemoteForBranch(String),
    DirtyWorkingTree,
    ConfigLoadingFailed,
    SshConfigFailed,
    FetchFailed(String),
    MergeConflict,
    TagMatchingFailed,
    FailedSettingHead(String),
}

A custom error describing the error cases for the GitCheck.

Variants

NotAGitRepository(String, String)

The directory is not a valid git repository.

NoHead

Cannot parse HEAD, either stuck an unborn branch or some deleted reference

NotOnABranch

There is no branch in the repository currently. It can be a repository without any branch, or checked out on a commit.

NoRemoteForBranch(String)

There is no remote for the current branch. This usually because the branch hasn’t been pulled.

DirtyWorkingTree

There are changes in the directory, avoiding pulling. This is a safety mechanism to avoid pulling over local changes, to not overwrite anything important.

ConfigLoadingFailed

Cannot load the git config

SshConfigFailed

Cannot create the ssh config

FetchFailed(String)

Cannot fetch the current branch. This can be a network failure, authentication error or many other things.

MergeConflict

Cannot pull updates to the current branch. This means either the merge analysis failed or there is a merge conflict.

TagMatchingFailed

Failed finding tags between the fetched commit and head. This might be a

FailedSettingHead(String)

Cannot set the HEAD to the fetch commit.

Trait Implementations

impl Debug for GitError

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

Formats the value using the given formatter.

impl Display for GitError

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

Formats the value using the given formatter.

impl Error for GitError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<GitError> for CheckError

fn from(value: GitError) -> Self

Converts to this type from the input type.