Enum GitError 

#[non_exhaustive]
pub enum GitError {
    CorruptRepo {
        path: PathBuf,
        message: String,
    },
    WalkFailed {
        path: PathBuf,
        message: String,
    },
}

Errors from gix repo inspection. CorruptRepo covers gix::open failures; WalkFailed covers HEAD / revwalk failures once the repo is open. Inner causes are stringified at the construction boundary so the enum stays Clone + PartialEq + Eq — the Arc<Result<...>> memoization boundary requires it. See docs/specs/git-segments.md §Change log (v0.1.1) for the full 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.

CorruptRepo

gix::discover or gix::open rejected the path.

Fields

path: PathBuf

message: String

WalkFailed

HEAD resolution or any post-open walk failed.

Fields

path: PathBuf

message: String

Implementations

impl GitError

pub fn code(&self) -> &'static str

Short plugin-facing tag per docs/specs/plugin-api.md §ctx shape exposed to rhai.

Trait Implementations

impl Clone for GitError

fn clone(&self) -> GitError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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, f: &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 PartialEq for GitError

fn eq(&self, other: &GitError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for GitError

impl StructuralPartialEq for GitError