Enum RepoError 

#[non_exhaustive]
pub enum RepoError {
    Io {
        path: PathBuf,
        source: Error,
    },
    OpenFailed {
        path: PathBuf,
        cause: String,
    },
    InitFailed {
        path: PathBuf,
        cause: String,
    },
    CloneFailed {
        url: String,
        cause: String,
    },
    FetchFailed {
        remote: String,
        cause: String,
    },
    CheckoutFailed {
        revspec: String,
        cause: String,
    },
    CommitFailed {
        cause: String,
    },
    StatusFailed {
        cause: String,
    },
    WalkFailed {
        cause: String,
    },
    DiffFailed {
        cause: String,
    },
    PushFailed {
        remote: String,
        refspec: String,
        cause: String,
    },
    RevspecNotFound {
        revspec: String,
    },
    DirtyWorkingTree {
        paths: Vec<PathBuf>,
    },
    Auth(CredentialError),
    PushUnsupported,
}

Errors surfaced by every method on crate::git::Repo.

Variant shape is part of the public API; backend internals are not. See the module docs for the rationale.

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.

Io

Filesystem-path failure (missing parent, permission denied, symlink loop). Path carried for diagnostics.

Fields

path: PathBuf

The path the operation tried to use.

source: Error

Underlying I/O failure.

OpenFailed

Repo::open could not load the repository at the given path. Backend-specific reason in cause (stringified).

Fields

path: PathBuf

The path that failed to open.

cause: String

Stringified backend error.

InitFailed

Repo::init could not create a repository at the given path.

Fields

path: PathBuf

The path where init was attempted.

cause: String

Stringified backend error.

CloneFailed

Clone setup or transport failure (URL parse, refs negotiation, network). Surfaces in Repo::clone (v0.5 commit 3).

Fields

url: String

The URL being cloned from.

cause: String

Stringified backend error.

FetchFailed

Fetch transport / refs failure. Surfaces in Repo::fetch (v0.5 commit 4).

Fields

remote: String

The remote name (typically origin).

cause: String

Stringified backend error.

CheckoutFailed

Checkout could not switch to revspec. Surfaces in Repo::checkout (v0.5 commit 4).

Fields

revspec: String

The revspec the caller asked for.

cause: String

Stringified backend error.

CommitFailed

Commit creation / staging failure. Surfaces in Repo::commit (v0.5 commit 3).

Fields

cause: String

Stringified backend error.

StatusFailed

Status walk failure. Surfaces in Repo::status when gix cannot iterate the worktree (e.g. permission errors).

Fields

cause: String

Stringified backend error.

WalkFailed

Commit-graph walk failure. Surfaces in Repo::walk for failures that aren’t RepoError::RevspecNotFound (gix internal error, object-store I/O, unsupported revspec kind).

Fields

cause: String

Stringified backend error.

DiffFailed

Tree-diff failure. Surfaces in Repo::diff for failures that aren’t RepoError::RevspecNotFound (gix internal error reading trees, blob diffing).

Fields

cause: String

Stringified backend error.

PushFailed

Push transport / refs failure. Only reachable when the git2-fallback Cargo feature is enabled.

Fields

remote: String

The remote name.

refspec: String

The refspec being pushed.

cause: String

Stringified backend error.

RevspecNotFound

Caller-facing error for revspecs (e.g. HEAD~999, a missing tag) that don’t resolve to a known object.

Fields

revspec: String

The revspec the caller asked for.

DirtyWorkingTree

Dirty-working-tree guard tripped. Listed paths are dirty. Operations affected: checkout, path-based commit.

Fields

paths: Vec<PathBuf>

The dirty paths discovered.

Auth(CredentialError)

Credential resolution failed. Wraps rtb-credentials’s existing error — not a backend leak because rtb-credentials is part of the framework’s stable public surface.

PushUnsupported

Push attempted with git2-fallback disabled. Help text points at the feature flag so users know how to enable push.

Trait Implementations

impl Debug for RepoError

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

Formats the value using the given formatter.

impl Diagnostic for RepoError

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for RepoError

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

Formats the value using the given formatter.

impl Error for RepoError

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<CredentialError> for RepoError

fn from(source: CredentialError) -> Self

Converts to this type from the input type.