Enum Event 

#[non_exhaustive]
pub enum Event<'a> {
    SessionStart {
        source: SessionSource,
    },
    SessionEnd,
    PreToolUse {
        action: &'a Action,
    },
    PostToolUse {
        action: &'a Action,
        result: &'a ToolResult,
    },
    PermissionRequest {
        action: &'a Action,
    },
    PreCompact {
        stage: CompactionStage,
    },
    PostCompact {
        stage: CompactionStage,
    },
    PreGuide {
        guide: &'a String,
    },
    PostGuide {
        guide: &'a String,
    },
    PreSensor {
        sensor: &'a String,
    },
    PostSensor {
        sensor: &'a String,
        signals: &'a [Signal],
    },
    PreAutoFix {
        patch: &'a FixPatch,
    },
    PostAutoFix {
        patch: &'a FixPatch,
        applied: bool,
    },
    PreModel {
        ctx: &'a Context,
    },
    PostModel {
        out: &'a ModelOutput,
    },
    ModelTokenDelta {
        text: &'a str,
    },
    SubagentStart {
        name: &'a str,
    },
    SubagentReport {
        status: SubagentStatus,
    },
    FileChanged {
        path: &'a PathBuf,
    },
    CwdChanged {
        from: &'a PathBuf,
        to: &'a PathBuf,
    },
    BlueprintNodeEnter {
        node: &'a str,
    },
    BlueprintNodeExit {
        node: &'a str,
    },
    TaskCompleted,
    BudgetWarning {
        ratio: f32,
    },
    Notification {
        kind: NotificationKind,
    },
    Error {
        message: &'a str,
    },
    Stop,
    Heartbeat {
        iter: u32,
    },
    Custom {
        name: &'a str,
        data: &'a Value,
    },
}

All 27 lifecycle events the framework emits (DESIGN.md §10).

Lifetimes are intentionally borrowed: hooks must not own these references past the call.

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.

SessionStart

Fields

source: SessionSource

SessionEnd

PreToolUse

Fields

action: &'a Action

PostToolUse

Fields

action: &'a Action

result: &'a ToolResult

PermissionRequest

Fields

action: &'a Action

PreCompact

Fields

stage: CompactionStage

PostCompact

Fields

stage: CompactionStage

PreGuide

Fields

guide: &'a String

PostGuide

Fields

guide: &'a String

PreSensor

Fields

sensor: &'a String

PostSensor

Fields

sensor: &'a String

signals: &'a [Signal]

PreAutoFix

Fields

patch: &'a FixPatch

PostAutoFix

Fields

patch: &'a FixPatch

applied: bool

PreModel

Fields

ctx: &'a Context

PostModel

Fields

out: &'a ModelOutput

ModelTokenDelta

Streaming-only: a text fragment arrived from Model::stream(). Fires 0..N times between PreModel and PostModel when the AgentLoop is in streaming mode. text is the new fragment (not the accumulator). Tool-call deltas are NOT surfaced here — the loop assembles those and emits the final PostModel with full tool_calls.

Fields

text: &'a str

SubagentStart

Fields

name: &'a str

SubagentReport

Fields

status: SubagentStatus

FileChanged

Fields

path: &'a PathBuf

CwdChanged

Fields

from: &'a PathBuf

to: &'a PathBuf

BlueprintNodeEnter

Fields

node: &'a str

BlueprintNodeExit

Fields

node: &'a str

TaskCompleted

BudgetWarning

Fields

ratio: f32

Notification

Fields

kind: NotificationKind

Error

Fields

message: &'a str

Stop

Heartbeat

Fields

iter: u32

Custom

Fields

name: &'a str

data: &'a Value

Implementations

impl<'a> Event<'a>

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

Stable string discriminant for matchers and serialization.

Trait Implementations

impl<'a> Debug for Event<'a>

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

Formats the value using the given formatter.