Enum HookEvent 

pub enum HookEvent {
    SessionStart,
    UserPromptSubmit,
    PreToolUse,
    PostToolUse,
    PostToolUseFailure,
    SubagentStart,
    SubagentStop,
    Stop,
    PreCompact,
    SessionEnd,
}

Lifecycle events that can trigger hooks.

Variants

SessionStart

Fired when a new session starts.

UserPromptSubmit

Fired when the user submits a prompt.

PreToolUse

Fired before a tool is executed.

PostToolUse

Fired after a tool executes successfully.

PostToolUseFailure

Fired after a tool execution fails.

SubagentStart

Fired when a subagent is spawned.

SubagentStop

Fired when a subagent finishes.

Stop

Fired when the agent decides to stop.

PreCompact

Fired before context compaction.

SessionEnd

Fired when the session ends.

Implementations

impl HookEvent

pub const ALL: &'static [HookEvent]

All valid event variants.

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

The string name used in config files (e.g., “PreToolUse”).

pub fn from_config_str(s: &str) -> Option<Self>

Parse from the string name used in config files.

pub fn is_tool_event(&self) -> bool

Whether this is a tool-related event.

pub fn is_subagent_event(&self) -> bool

Whether this is a subagent-related event.

Trait Implementations

impl Clone for HookEvent

fn clone(&self) -> HookEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookEvent

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

Formats the value using the given formatter.

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 Display for HookEvent

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

Formats the value using the given formatter.

impl Hash for HookEvent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for HookEvent

fn eq(&self, other: &HookEvent) -> 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 HookEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for HookEvent

impl Eq for HookEvent

impl StructuralPartialEq for HookEvent