Enum HookEvent 

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

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

PreToolUse

PostToolUse

PostToolUseFailure

UserPromptSubmit

Stop

SubagentStart

SubagentStop

PreCompact

SessionStart

SessionEnd

Implementations

impl HookEvent

pub fn can_block(&self) -> bool

Returns true if this hook event can block execution.

Blockable events use fail-closed semantics: if the hook fails or times out, the operation is blocked. This ensures security policies are enforced.

Blockable events:

• PreToolUse: Can block tool execution
• UserPromptSubmit: Can block prompt processing
• SessionStart: Can block session initialization
• PreCompact: Can block context compaction
• SubagentStart: Can block subagent spawning

pub fn can_modify_input(&self) -> bool

pub fn all() -> &'static [HookEvent]

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