Struct HookDecision 

pub struct HookDecision {
    inner: HookDecisionKind,
}

A hook decision.

The shape (allow / deny / replace-input / passthrough) mirrors the CLI’s SyncHookJSONOutput.decision field. See the hook-callback contract docs for the full wire story.

Fields

inner: HookDecisionKind

Implementations

impl HookDecision

fn with_inner(inner: HookDecisionKind) -> Self

pub fn allow() -> Self

Allow the action unchanged.

pub fn replace_input(new_input: Value) -> Self

Allow but substitute a new input payload (PreToolUse / UserPromptSubmit).

pub fn deny(reason: impl Into<String>) -> Self

Deny the action with a reason string.

pub fn passthrough() -> Self

Observational only - continue unchanged (typical PostToolUse / Stop).

pub fn defer(timeout_ms: Option<u64>) -> Self

Defer the hook response. Emits the CLI’s AsyncHookJSONOutput shape: {"async": true, "asyncTimeout": <ms>?}. Pass None for no explicit timeout. The CLI will proceed without waiting for the hook’s final verdict; the caller is expected to deliver the real decision out-of-band (wiring that channel is follow-up work - forge-sdk currently emits only the ACK shape).

pub fn is_deferred(&self) -> bool

True iff the decision was constructed via defer.

pub fn defer_timeout_ms(&self) -> Option<u64>

Optional timeout in milliseconds attached to a defer decision.

pub fn is_allow(&self) -> bool

True if the decision allows the action.

pub fn updated_input(&self) -> Option<&Value>

Optional modified input.

pub fn reason(&self) -> Option<&str>

Optional deny reason.

Trait Implementations

impl Clone for HookDecision

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 HookDecision

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

Formats the value using the given formatter.