Enum HookResult 

pub enum HookResult {
    Success {
        output: HookOutput,
    },
    NotFound,
    Failed {
        status: i32,
        output: HookOutput,
    },
}

Result of running the hooks for one event.

Variants

Success

Every hook ran and exited 0.

Fields

output: HookOutput

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

NotFound

No hook is installed for the event (or it is not executable) — treated as success.

Failed

A hook exited non-zero; later hooks for the event did not run.

Fields

status: i32

Exit code of the failing hook (1 when it had none, e.g. killed by a signal).

output: HookOutput

What the hooks wrote up to and including the failing one; empty under HookStdio::Inherit.

Implementations

impl HookResult

pub fn is_ok(&self) -> bool

Returns true if the hook was successful or not found.

pub fn was_executed(&self) -> bool

Returns true if the hook existed and ran (regardless of exit code).

pub fn status(&self) -> Option<i32>

Exit code of the hook run: Some(0) on success, None when no hook ran.

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

Captured output, or None when no hook ran.

pub fn check(self, hook_name: &str) -> Result<bool, HookError>

Turn a failed run into HookError::Failed for hook_name; returns whether a hook ran.

Errors

HookError::Failed carrying the status and captured output when a hook exited non-zero.

Trait Implementations

impl Clone for HookResult

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 HookResult

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

Formats the value using the given formatter.

impl Eq for HookResult

impl PartialEq for HookResult

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HookResult