Struct HookOutput 

pub struct HookOutput {
    pub decision: HookDecision,
    pub reason: Option<String>,
    pub updated_input: Option<Value>,
    pub extra: Option<Value>,
}

The output returned by a hook callback.

Fields

decision: HookDecision

The hook’s decision.

reason: Option<String>

Human-readable reason for the decision.

updated_input: Option<Value>

Updated tool input (only meaningful for PreToolUse).

extra: Option<Value>

Extra data for future extension.

Implementations

impl HookOutput

pub fn allow() -> Self

Convenience: allow the event to proceed.

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

Convenience: block the tool execution.

pub fn modify(updated_input: Value) -> Self

Convenience: modify the tool input.

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

Convenience: abort the session.

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<'de> Deserialize<'de> for HookOutput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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