Enum UserEvent 

pub enum UserEvent {
    Progress {
        text: String,
    },
    Structured {
        event_type: String,
        data: Value,
    },
    ToolPartialResult {
        tool_call_id: String,
        content: String,
        is_partial: bool,
    },
    Notice {
        kind: NoticeKind,
        source: String,
        text: String,
    },
}

Plan / user lifecycle event types surfaced to consumers. User-space events produced by tools during execution.

Tools send these through ToolContext::emit_user_event(). The framework wraps them in RuntimeEvent::UserEvent before delivering to external consumers.

Variants

Progress

Tool progress notification.

Fields

text: String

Structured

User-defined structured event for custom business semantics.

Fields

event_type: String

data: Value

ToolPartialResult

Tool partial result — emitted during long-running tool execution. is_partial: true means more output is coming; false means this is the final chunk.

Fields

tool_call_id: String

content: String

is_partial: bool

Notice

Display-only notice from an engine mechanism (guard degradation, reaper, …). text is a mechanism-level English fact; product layers may rewrite it per source. source is a String (not &'static str) because UserEvent must deserialize across process boundaries.

Fields

kind: NoticeKind

source: String

text: String

Trait Implementations

impl Clone for UserEvent

fn clone(&self) -> UserEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UserEvent

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.