Enum HookEvent 

pub enum HookEvent {
    ResponseStart {
        response_id: String,
    },
    ResponseDelta {
        response_id: String,
        delta: String,
    },
    ResponseEnd {
        response_id: String,
    },
    ToolLifecycle {
        response_id: String,
        tool_name: String,
        phase: String,
        payload: Value,
    },
    JobLifecycle {
        job_id: String,
        phase: String,
        progress: Option<u8>,
        detail: Option<String>,
    },
    ApprovalLifecycle {
        approval_id: String,
        phase: String,
        reason: Option<String>,
    },
    GenericEventFrame {
        frame: EventFrame,
    },
}

All events that can be emitted through the hook system.

Each variant represents a distinct lifecycle or streaming event. The enum is serialised with a "type" discriminator using snake_case naming (e.g. "response_start", "tool_lifecycle"), making it easy to consume from JSON-based log files or webhook receivers.

Variants

ResponseStart

A new response stream has started.

Fields

response_id: String

Unique identifier for the response being streamed.

ResponseDelta

A chunk of text has been received for an in-progress response.

Fields

response_id: String

Unique identifier for the response being streamed.

delta: String

The incremental text content of this chunk.

ResponseEnd

A response stream has finished.

Fields

response_id: String

Unique identifier for the response that completed.

ToolLifecycle

A tool invocation has transitioned to a new phase (e.g. start, end, error).

Fields

response_id: String

Identifier of the response under which the tool was invoked.

tool_name: String

Name of the tool (e.g. "shell", "read_file").

phase: String

Current phase of the tool execution (e.g. "start", "end").

payload: Value

Arbitrary structured payload associated with this phase.

JobLifecycle

A background job has transitioned to a new phase.

Fields

job_id: String

Unique identifier of the job.

phase: String

Current phase of the job (e.g. "queued", "running", "done").

progress: Option<u8>

Optional progress percentage (0-100).

detail: Option<String>

Optional human-readable detail about the current phase.

ApprovalLifecycle

An approval request has transitioned to a new phase.

Fields

approval_id: String

Unique identifier of the approval request.

phase: String

Current phase (e.g. "requested", "approved", "denied").

reason: Option<String>

Optional reason explaining the current phase.

GenericEventFrame

A catch-all variant that wraps an arbitrary EventFrame.

Use this when you need to forward a protocol-level event frame without mapping it to a more specific variant.

Fields

frame: EventFrame

The raw event frame to forward.

Implementations

impl HookEvent

pub fn to_json(&self) -> Value

Serialise this event into a serde_json::Value.

Returns a JSON object with the "type" discriminator and all variant fields. If serialisation fails (which should be extremely rare), a fallback {"type":"serialization_error"} value is returned instead of panicking.

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 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.