Enum GitError 

#[non_exhaustive]
pub enum GitError {
    NotFound {
        path: PathBuf,
    },
    RefNotFound {
        refname: String,
    },
    RemoteNotFound {
        name: String,
    },
    ConfigNotFound {
        key: String,
    },
    AmbiguousRef {
        refname: String,
    },
    AlreadyExists {
        kind: &'static str,
        name: String,
    },
    CheckedOutBranch {
        name: String,
    },
    Conflict {
        path: PathBuf,
    },
    DetachedHead,
    InvalidLineRange {
        start: usize,
        end: usize,
    },
    InvalidPath {
        path: String,
    },
    InvalidConfigKey {
        key: String,
    },
    NoMergeBase {
        a: String,
        b: String,
    },
    SigningNotSupported,
    IdentityMissing {
        key: String,
    },
    InvalidTransport {
        kind: String,
    },
    Network(String),
    RemoteAuth {
        message: String,
    },
    PushRejected {
        refname: String,
        reason: String,
    },
    CommandFailed {
        args: Vec<String>,
        exit_code: Option<i32>,
        stdout: String,
        stderr: String,
        stdout_truncated: bool,
        stderr_truncated: bool,
    },
    InvalidOid {
        value: String,
    },
    NotImplemented {
        operation: &'static str,
    },
    Internal(Error),
}

Git domain errors.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NotFound

Repository not found at path.

Fields

path: PathBuf

Filesystem path that did not contain a git repository.

RefNotFound

Git reference not found.

Fields

refname: String

Missing reference name.

RemoteNotFound

Remote not found.

Fields

name: String

Missing remote name.

ConfigNotFound

Config key not found.

Fields

key: String

Missing config key.

AmbiguousRef

Ambiguous git reference.

Fields

refname: String

Reference name that resolved to multiple candidates.

AlreadyExists

Existing resource conflict.

Fields

kind: &'static str

Existing resource kind.

name: String

Existing resource name.

CheckedOutBranch

Attempted to delete the currently checked out branch.

Fields

name: String

Branch name.

Conflict

Merge conflict in a file.

Fields

path: PathBuf

Path containing merge conflict markers or index conflicts.

DetachedHead

HEAD is detached (not pointing to a branch).

InvalidLineRange

Invalid blame line range.

Fields

start: usize

One-based starting line.

end: usize

One-based ending line.

InvalidPath

Invalid repository path.

Fields

path: String

Invalid repository-relative path.

InvalidConfigKey

Invalid git config key.

Fields

key: String

Invalid git config key.

NoMergeBase

No merge base exists between the two commits.

Fields

a: String

First commit reference.

b: String

Second commit reference.

SigningNotSupported

Commit signing is not supported by the selected backend.

IdentityMissing

Git author/committer identity is not configured.

libgit2 cannot build a default signature because user.name and/or user.email are unset in the effective git configuration. This is an actionable configuration problem, not an internal failure.

Fields

key: String

Missing identity config key (for example user.name or user.email).

InvalidTransport

Unsupported transport configuration.

Fields

kind: String

Transport kind that could not be applied.

Network(String)

Network error during remote operations.

RemoteAuth

Authentication or authorization failure during a remote operation.

libgit2 reports the transport-level failure (bad credentials, expired token, insufficient scope/permission) via an Auth code or an Http/Ssh/Callback class. This is an actionable access problem, not an internal failure, so its (credential-redacted) message is surfaced to the user.

Fields

message: String

Credential-redacted description of the authentication failure.

PushRejected

The remote rejected the push of one or more references.

Covers a non-fast-forward update, a protected-branch/hook rejection, and any other server-reported ref rejection. The rejection is reported by the remote (not an internal failure), so the offending ref and the (credential-redacted) reason are surfaced to the user.

Fields

refname: String

Fully-qualified destination reference(s) the remote rejected; a comma-separated list when several refs were pushed together.

reason: String

Credential-redacted rejection reason reported by the remote.

CommandFailed

Git CLI command failure.

Fields

args: Vec<String>

CLI arguments that were attempted.

exit_code: Option<i32>

Process exit code, if available.

stdout: String

Standard output (may contain conflict diagnostics).

stderr: String

Standard error output.

stdout_truncated: bool

Whether stdout exceeded the configured capture limit.

stderr_truncated: bool

Whether stderr exceeded the configured capture limit.

InvalidOid

Invalid object ID string.

Fields

value: String

Invalid hex value.

NotImplemented

Operation is intentionally not implemented.

Fields

operation: &'static str

Unimplemented operation name.

Internal(Error)

Internal git2 error.

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<Error> for GitError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<GitError> for AppError

fn from(error: GitError) -> Self

Converts to this type from the input type.