Struct HookOutput 

pub struct HookOutput {
    pub should_continue: bool,
    pub hook_specific_output: Option<HookSpecificOutput>,
}

The complete hook output sent to an agent via stdout.

Fields

should_continue: bool

hook_specific_output: Option<HookSpecificOutput>

Implementations

impl HookOutput

pub fn allow(reason: Option<String>, context: Option<String>) -> Self

Create an “allow” response for PreToolUse - bypasses permission system.

pub fn deny(reason: String, context: Option<String>) -> Self

Create a “deny” response for PreToolUse - prevents tool execution.

pub fn ask(reason: Option<String>, context: Option<String>) -> Self

Create an “ask” response for PreToolUse - prompts user for confirmation.

pub fn approve_permission(updated_input: Option<Value>) -> Self

Approve a permission request on behalf of the user.

pub fn deny_permission(message: String, interrupt: bool) -> Self

Deny a permission request on behalf of the user.

pub fn set_updated_input(&mut self, updated_input: Value)

Set the updated_input field on a PreToolUse response. This rewrites the tool input before the agent executes it.

pub fn session_start(additional_context: Option<String>) -> Self

Create a SessionStart response with optional context about the session setup.

pub fn post_tool_use(additional_context: Option<String>) -> Self

Create a PostToolUse response with optional advisory context.

pub fn continue_execution() -> Self

Continue execution without making a decision (for informational hooks).

pub fn write_to(&self, writer: impl Write) -> Result<()>

Write response to any writer (for testability).

pub fn write_stdout(&self) -> Result<()>

Write response to stdout (convenience wrapper for production).

pub fn effect(&self) -> Option<Effect>

Extract the Effect from this output, if it contains a PreToolUse decision.

Trait Implementations

impl Clone for HookOutput

fn clone(&self) -> HookOutput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HookOutput

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

Formats the value using the given formatter.

impl PartialEq for HookOutput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HookOutput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HookOutput