Struct HookResult 

pub struct HookResult {
    pub action: HookAction,
    pub additional_context: Option<String>,
    pub updated_input: Option<Value>,
    pub system_message: Option<String>,
    pub suppress_output: bool,
    pub permission_decision: Option<PermissionDecision>,
    pub permission_decision_reason: Option<String>,
}

Rich result returned by a hook dispatch, containing the primary action as well as optional structured metadata for the caller to consume.

Fields

action: HookAction

Primary decision.

additional_context: Option<String>

Extra context to inject into the next LLM system prompt.

updated_input: Option<Value>

Override tool arguments (meaningful only for PreToolCall).

system_message: Option<String>

User-facing warning message.

suppress_output: bool

When true, suppress the hook’s raw stdout from the transcript.

permission_decision: Option<PermissionDecision>

Explicit permission decision (overrides normal permission check).

permission_decision_reason: Option<String>

Reason for the permission decision (for audit logging).

Implementations

impl HookResult

pub fn continue_default() -> Self

Shorthand for the default “do nothing” result.

pub fn from_fail_mode( mode: HookFailMode, reason: &str, event: &HookEvent, ) -> Self

Produce a hook result based on the fail mode.

• Open (default): returns Continue — preserves pre-Goal-281 fail-open behavior for notification hooks.
• Closed: for gating events (PreToolCall, UserPromptSubmit, PermissionRequest) returns Error(reason) so the agent sees the failure as a rejection. For all other event types (notification hooks like PostToolCall, SessionStart, etc.) returns Continue since a notification failure shouldn’t block.

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 Default for HookResult

fn default() -> Self

Returns the “default value” for a type.