Enum HookEvent 

#[non_exhaustive]
pub enum HookEvent {
    PreToolUse {
        input: PreToolUseInput,
        ctx: HookContext,
    },
    PostToolUse {
        input: PostToolUseInput,
        ctx: HookContext,
    },
    UserPromptSubmitted {
        input: UserPromptSubmittedInput,
        ctx: HookContext,
    },
    SessionStart {
        input: SessionStartInput,
        ctx: HookContext,
    },
    SessionEnd {
        input: SessionEndInput,
        ctx: HookContext,
    },
    ErrorOccurred {
        input: ErrorOccurredInput,
        ctx: HookContext,
    },
}

Events dispatched to SessionHooks::on_hook at CLI lifecycle points.

Each variant carries the typed input for that hook plus the shared HookContext. The handler returns a matching HookOutput variant (or HookOutput::None to signal “no hook registered”).

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

Fired before a tool executes.

Fields

input: PreToolUseInput

Typed input data.

ctx: HookContext

Session context.

PostToolUse

Fired after a tool executes.

Fields

input: PostToolUseInput

Typed input data.

ctx: HookContext

Session context.

UserPromptSubmitted

Fired when the user sends a message.

Fields

input: UserPromptSubmittedInput

Typed input data.

ctx: HookContext

Session context.

SessionStart

Fired at session creation or resume.

Fields

input: SessionStartInput

Typed input data.

ctx: HookContext

Session context.

SessionEnd

Fired when the session ends.

Fields

input: SessionEndInput

Typed input data.

ctx: HookContext

Session context.

ErrorOccurred

Fired when an error occurs.

Fields

input: ErrorOccurredInput

Typed input data.

ctx: HookContext

Session context.

Trait Implementations

impl Debug for HookEvent

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

Formats the value using the given formatter.