Enum HookPayload 

pub enum HookPayload {
    None,
    SessionSetup {
        initial_message: String,
        source: SessionStartSource,
    },
    Round {
        round: u32,
    },
    Prompt {
        prompt: String,
    },
    ToolExecution {
        tool_name: String,
        tool_call_id: String,
        parsed_args: Value,
    },
    ToolResult {
        tool_name: String,
        tool_call_id: String,
        outcome: HookToolOutcome,
    },
    Compression {
        estimated_tokens: u32,
        usage_percent: f64,
        max_context_tokens: u32,
        trigger_context_tokens: u32,
        trigger: String,
        phase: String,
    },
    Notification {
        id: Option<String>,
        category: String,
        priority: String,
        title: String,
        body: String,
        dedup_key: Option<String>,
        created_at: Option<String>,
        click_url: Option<String>,
    },
    Finalize {
        stop_hook_active: bool,
    },
    SessionEnd {
        status: SessionEndStatus,
        completion_reason: Option<String>,
    },
}

Point-specific data supplied to an AgentHookPoint callback.

Payloads own their data deliberately. Hooks are asynchronous and may be shared by concurrent runs, so keeping the public contract free of borrowed engine-only types makes it serializable, easy to test, and preserves the domain/engine dependency boundary.

Variants

None

A point currently has no additional structured data.

SessionSetup

Session initialization completed for this user turn.

Fields

initial_message: String

source: SessionStartSource

Round

A round is about to start or has just completed.

Fields

round: u32

Prompt

A prompt-oriented hook payload reserved for prompt/LLM seams.

Fields

prompt: String

ToolExecution

A parsed tool call immediately before dispatch.

Fields

tool_name: String

tool_call_id: String

parsed_args: Value

ToolResult

A tool outcome immediately before it is applied to the session.

Fields

tool_name: String

tool_call_id: String

outcome: HookToolOutcome

Compression

Context compression is about to begin.

Fields

estimated_tokens: u32

usage_percent: f64

max_context_tokens: u32

trigger_context_tokens: u32

trigger: String

phase: String

Notification

A classified, deduplicated notification is being delivered to sinks.

Fields

id: Option<String>

category: String

priority: String

title: String

body: String

dedup_key: Option<String>

created_at: Option<String>

click_url: Option<String>

Finalize

The run is about to emit its terminal completion event.

Fields

stop_hook_active: bool

SessionEnd

The run reached a terminal status and is about to be persisted.

Fields

status: SessionEndStatus

completion_reason: Option<String>

Trait Implementations

impl Clone for HookPayload

fn clone(&self) -> HookPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookPayload

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

Formats the value using the given formatter.

impl Default for HookPayload

fn default() -> HookPayload

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HookPayload

fn deserialize<__D>( __deserializer: __D, ) -> Result<HookPayload, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HookPayload

fn eq(&self, other: &HookPayload) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for HookPayload

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HookPayload