Enum HookError 

pub enum HookError {
    Failed {
        hook_name: String,
        status: i32,
        output: HookOutput,
    },
    Spawn {
        hook_name: String,
        path: PathBuf,
        source: Error,
        output: HookOutput,
    },
    Internal(String),
    Cancelled,
}

Hook subprocess failure (non-zero exit or spawn error).

Variants

Failed

A hook ran and returned a non-zero exit status.

The message is one line; the hook’s own output is in output, never in Display.

Fields

hook_name: String

Basename of the hook script that failed.

status: i32

Process exit code from the hook subprocess.

output: HookOutput

What the hooks wrote; empty under HookStdio::Inherit.

Spawn

The hook (or the shell that runs it) could not be started.

Fields

hook_name: String

Hook event name (pre-commit, commit-msg, …).

path: PathBuf

Program that failed to start: the hook script, or the interpreter chosen for it.

source: Error

Error returned by the CommandRunner when spawning.

output: HookOutput

What earlier hooks for the same event wrote before this one could not start (configured hook.<name>.* entries run before the hooks directory script); empty under HookStdio::Inherit.

Internal(String)

Configuration or internal error while resolving hooks.

Cancelled

The hook subprocess was stopped because the operation was cancelled.

Implementations

impl HookError

pub fn output(&self) -> Option<&HookOutput>

Hook output captured before the failure, or None for HookError::Internal.

Trait Implementations

impl Debug for HookError

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

Formats the value using the given formatter.

impl Display for HookError

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

Formats the value using the given formatter.

impl Error for HookError

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

fn from(err: HookError) -> Self

Converts to this type from the input type.

impl From<String> for HookError

fn from(value: String) -> Self

Converts to this type from the input type.