Enum GitError 

#[non_exhaustive]
pub enum GitError {
    DestinationNotEmpty(PathBuf),
    NotARepository(PathBuf),
    RefNotFound(String),
    DirtyWorkingTree(PathBuf),
    CloneFailed {
        url: String,
        detail: String,
    },
    FetchFailed(PathBuf, String),
    CheckoutFailed {
        ref: String,
        detail: String,
    },
    Internal(String),
}

Errors produced by any crate::git::GitBackend implementation.

The enum is #[non_exhaustive] so future slices (credentials, submodules, partial fetch) can add variants without a breaking change.

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.

DestinationNotEmpty(PathBuf)

Clone was asked to populate a destination that already contains files.

NotARepository(PathBuf)

Operation was asked to act on a path that does not hold a git repo.

RefNotFound(String)

A ref (branch, tag, or SHA) could not be resolved in the repository.

DirtyWorkingTree(PathBuf)

Checkout refused because the working tree has uncommitted changes.

CloneFailed

Clone failed at the backend layer. detail carries the backend message verbatim for operator diagnosis.

Fields

url: String

Remote URL that was being cloned.

detail: String

Backend-provided failure detail.

FetchFailed(PathBuf, String)

Fetch failed at the backend layer.

CheckoutFailed

Checkout of a resolved ref failed to apply to the working tree.

Fields

ref: String

Ref name (branch, tag, or SHA) that was being checked out.

detail: String

Backend-provided failure detail.

Internal(String)

Catch-all for unexpected backend errors. Carries the detail string so the caller can log or surface it without losing information.

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 TreeError

fn from(source: GitError) -> Self

Converts to this type from the input type.