Struct HookDecision 

pub struct HookDecision { /* private fields */ }

A hook decision to continue, block, or replace input.

Returning Some(decision) stops the remaining hooks for that event, even when the decision is continue_. Return None to let the next hook decide. Default blocks execution with no reason or replacement.

Implementations

impl HookDecision

pub fn continue_() -> Self

Continues the operation without modifications, skipping subsequent hooks.

Return None from the hook instead when later hooks should also run.

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

Blocks the prompt or tool call with the supplied reason.

A blocked prompt becomes an error; a blocked automatic tool call becomes an error result sent back to the model.

pub fn modify_input(input: Value, reason: impl Into<String>) -> Self

Continues with replacement tool input.

In a post-tool hook, the same field replaces the tool result instead.

pub fn modify_prompt( prompt: impl Into<String>, reason: impl Into<String>, ) -> Self

Continues with replacement prompt text in a user-prompt-submit hook.

pub fn continue_execution(&self) -> bool

Returns whether execution should continue.

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

Returns the modified input, if any.

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

Returns the modified prompt, if any.

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

Returns the reason, if any.

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.

impl Default for HookDecision

fn default() -> Self

Returns the “default value” for a type.