Enum HookEvent 

pub enum HookEvent {
    PreTool,
    PreToolTransform,
    PostTool,
    SessionStart,
    UserPromptSubmit,
    Stop,
    PreCompact,
    SubagentStop,
}

When a hook runs relative to a tool call.

Variants

PreTool

Before the tool executes. Non-zero exit can block when block_on_failure.

PreToolTransform

Before every gate: a successful hook whose stdout is a JSON object replaces the tool input. Failures keep the input (fail open).

PostTool

After the tool finishes. Failures are logged only.

SessionStart

Once per session in this process (new or resumed), before its first turn.

UserPromptSubmit

Before each user turn. Non-zero exit can block the turn when block_on_failure.

Stop

After a user turn finishes with a reply.

PreCompact

Before the transcript is compacted (auto, overflow, or /compact).

SubagentStop

After a task / swarm subagent finishes. match filters the agent type.

Implementations

impl HookEvent

pub fn as_str(self) -> &'static str

Config spelling (pre_tool, session_start, …).

pub fn can_block(self) -> bool

Whether block_on_failure can refuse the action (tool call / turn).

Trait Implementations

impl Clone for HookEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HookEvent

impl Debug for HookEvent

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

Formats the value using the given formatter.

impl Default for HookEvent

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HookEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for HookEvent

impl PartialEq for HookEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for HookEvent

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 HookEvent