Enum FilterError 

#[non_exhaustive]
pub enum FilterError {
    ExternalFilterFailed {
        driver: String,
        path: String,
        phase: FilterPhase,
    },
    ExternalFilterSpawnFailed {
        driver: String,
        path: String,
        phase: FilterPhase,
        program: String,
        kind: ErrorKind,
        detail: String,
    },
    NotFilteredProperly {
        path: String,
        detail: String,
    },
    InvalidWorkingTreeEncoding,
    LineEndingWouldChange {
        detail: String,
    },
    Failed {
        status: i32,
    },
}

Clean/smudge filter and EOL conversion failures.

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.

ExternalFilterFailed

External clean or smudge filter command failed.

Fields

driver: String

Filter driver name from .gitattributes.

path: String

Repository-relative or filesystem path related to the failure.

phase: FilterPhase

Whether the clean or smudge filter hook failed.

ExternalFilterSpawnFailed

A required clean or smudge filter could not be started (for example, no shell to run it), so the content was neither filtered nor stored unfiltered.

Fields

driver: String

Filter driver name from .gitattributes.

path: String

Repository-relative path being filtered.

phase: FilterPhase

Whether the clean or smudge filter was being started.

program: String

Program grit tried to spawn (sh for shell-command filters).

kind: ErrorKind

OS error kind from the failed spawn.

detail: String

OS error message from the failed spawn.

NotFilteredProperly

Filter output did not round-trip (clean/smudge mismatch).

Fields

path: String

Repository-relative or filesystem path related to the failure.

detail: String

Why clean/smudge output did not round-trip.

InvalidWorkingTreeEncoding

Invalid working-tree-encoding attribute value.

LineEndingWouldChange

Line-ending conversion would modify the worktree against user settings.

Fields

detail: String

Additional human-readable detail for the failure.

Failed

Shell filter subprocess exited non-zero.

Fields

status: i32

Subprocess exit status from the filter command.

Trait Implementations

impl Clone for FilterError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilterError

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

Formats the value using the given formatter.

impl Display for FilterError

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

Formats the value using the given formatter.

impl Eq for FilterError

impl Error for FilterError

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

fn from(source: FilterError) -> Self

Converts to this type from the input type.

impl PartialEq for FilterError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FilterError