Enum EventData 

pub enum EventData {
    InputMessage(InputMessageData),
    OutputMessageDelta(OutputMessageDeltaData),
    OutputMessageStarted(OutputMessageStartedData),
    OutputMessageReplaced(OutputMessageReplacedData),
    OutputMessageCompleted(OutputMessageCompletedData),
    TurnStarted(TurnStartedData),
    TurnCompleted(TurnCompletedData),
    TurnFailed(TurnFailedData),
    ReasonStarted(ReasonStartedData),
    ReasonCompleted(ReasonCompletedData),
    CapabilityUsage(CapabilityUsageData),
    ActStarted(ActStartedData),
    ActCompleted(ActCompletedData),
    ToolStarted(ToolStartedData),
    ToolCompleted(ToolCompletedData),
    ToolProgress(ToolProgressData),
    ToolOutputDelta(ToolOutputDeltaData),
    ToolCallRequested(ToolCallRequestedData),
    LlmGeneration(LlmGenerationData),
    ReasonThinkingDelta(ReasonThinkingDeltaData),
    ReasonItem(ReasonItemData),
    ReasonThinkingStarted(ReasonThinkingStartedData),
    ReasonThinkingCompleted(ReasonThinkingCompletedData),
    TurnCancelled(TurnCancelledData),
    SessionStarted(SessionStartedData),
    SessionActivated(SessionActivatedData),
    SessionIdled(SessionIdledData),
    SubagentSpawned(SubagentEventData),
    SubagentCompleted(SubagentEventData),
    SubagentFailed(SubagentEventData),
    SubagentCancelled(SubagentEventData),
    ContextCompacting(ContextCompactingData),
    ContextCompacted(ContextCompactedData),
    FileWritten(FileWrittenData),
    BudgetWarning(BudgetEventData),
    BudgetPaused(BudgetEventData),
    BudgetExhausted(BudgetEventData),
    BudgetResumed(BudgetEventData),
    VoiceSessionStarted(VoiceSessionStartedData),
    VoiceInputTranscriptDelta(VoiceTranscriptData),
    VoiceInputTranscriptCompleted(VoiceTranscriptData),
    VoiceOutputTranscriptDelta(VoiceTranscriptData),
    VoiceOutputTranscriptCompleted(VoiceTranscriptData),
    VoiceSessionEnded(VoiceSessionEndedData),
    VoiceSessionFailed(VoiceSessionFailedData),
    Unsupported {
        event_type: String,
        data: Value,
    },
}

Typed event data enum for all event payloads

This enum provides type safety for event data. Each variant corresponds to a specific event type and contains the appropriate data structure. The Raw variant is used for backward compatibility with legacy events or unknown event types.

The data type depends on the event type field:

• input.message → InputMessageData
• output.message.started → OutputMessageStartedData
• output.message.delta → OutputMessageDeltaData
• output.message.completed → OutputMessageCompletedData
• turn.started → TurnStartedData
• turn.completed → TurnCompletedData
• turn.failed → TurnFailedData
• turn.cancelled → TurnCancelledData
• reason.started → ReasonStartedData
• reason.completed → ReasonCompletedData
• capability.usage → CapabilityUsageData
• act.started → ActStartedData
• act.completed → ActCompletedData
• tool.started → ToolStartedData
• tool.completed → ToolCompletedData
• tool.output.delta → ToolOutputDeltaData
• tool.call_requested → ToolCallRequestedData
• llm.generation → LlmGenerationData
• reason.thinking.started → ReasonThinkingStartedData
• reason.thinking.delta → ReasonThinkingDeltaData
• reason.thinking.completed → ReasonThinkingCompletedData
• reason.item → ReasonItemData
• session.started → SessionStartedData
• session.activated → SessionActivatedData
• session.idled → SessionIdledData
• subagent.spawned → SubagentEventData
• subagent.completed → SubagentEventData
• subagent.failed → SubagentEventData
• subagent.cancelled → SubagentEventData
• file.written → FileWrittenData

Variants

InputMessage(InputMessageData)

OutputMessageDelta(OutputMessageDeltaData)

OutputMessageStarted(OutputMessageStartedData)

OutputMessageReplaced(OutputMessageReplacedData)

OutputMessageCompleted(OutputMessageCompletedData)

TurnStarted(TurnStartedData)

TurnCompleted(TurnCompletedData)

TurnFailed(TurnFailedData)

ReasonStarted(ReasonStartedData)

ReasonCompleted(ReasonCompletedData)

CapabilityUsage(CapabilityUsageData)

ActStarted(ActStartedData)

ActCompleted(ActCompletedData)

ToolStarted(ToolStartedData)

ToolCompleted(ToolCompletedData)

ToolProgress(ToolProgressData)

ToolOutputDelta(ToolOutputDeltaData)

ToolCallRequested(ToolCallRequestedData)

LlmGeneration(LlmGenerationData)

ReasonThinkingDelta(ReasonThinkingDeltaData)

ReasonItem(ReasonItemData)

ReasonThinkingStarted(ReasonThinkingStartedData)

ReasonThinkingCompleted(ReasonThinkingCompletedData)

TurnCancelled(TurnCancelledData)

SessionStarted(SessionStartedData)

SessionActivated(SessionActivatedData)

SessionIdled(SessionIdledData)

SubagentSpawned(SubagentEventData)

SubagentCompleted(SubagentEventData)

SubagentFailed(SubagentEventData)

SubagentCancelled(SubagentEventData)

ContextCompacting(ContextCompactingData)

ContextCompacted(ContextCompactedData)

FileWritten(FileWrittenData)

BudgetWarning(BudgetEventData)

BudgetPaused(BudgetEventData)

BudgetExhausted(BudgetEventData)

BudgetResumed(BudgetEventData)

VoiceSessionStarted(VoiceSessionStartedData)

VoiceInputTranscriptDelta(VoiceTranscriptData)

VoiceInputTranscriptCompleted(VoiceTranscriptData)

VoiceOutputTranscriptDelta(VoiceTranscriptData)

VoiceOutputTranscriptCompleted(VoiceTranscriptData)

VoiceSessionEnded(VoiceSessionEndedData)

VoiceSessionFailed(VoiceSessionFailedData)

Unsupported

Internal-only variant for unknown event types. Never serialized to API responses - filtered out before transmission. Logs a warning when created to alert developers of unknown types.

Fields

event_type: String

The unknown event type string

data: Value

The raw JSON data

Implementations

impl EventData

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

Get the event type constant for this data. For Unsupported events, returns “unsupported” (internal use only).

pub fn is_unsupported(&self) -> bool

Check if this is an unsupported event type. Unsupported events should be filtered before API responses.

pub fn unsupported(event_type: String, data: Value) -> Self

Create an unsupported event data with warning log. This is used when deserializing unknown event types.

impl EventData

pub fn voice_transcript_event( data: VoiceTranscriptData, event_type: &str, ) -> Self

impl EventData

pub fn budget_event(data: BudgetEventData, event_type: &str) -> Self

Trait Implementations

impl Clone for EventData

fn clone(&self) -> EventData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ActCompletedData> for EventData

fn from(data: ActCompletedData) -> Self

Converts to this type from the input type.

impl From<ActStartedData> for EventData

fn from(data: ActStartedData) -> Self

Converts to this type from the input type.

impl From<CapabilityUsageData> for EventData

fn from(data: CapabilityUsageData) -> Self

Converts to this type from the input type.

impl From<ContextCompactedData> for EventData

fn from(data: ContextCompactedData) -> Self

Converts to this type from the input type.

impl From<ContextCompactingData> for EventData

fn from(data: ContextCompactingData) -> Self

Converts to this type from the input type.

impl From<FileWrittenData> for EventData

fn from(data: FileWrittenData) -> Self

Converts to this type from the input type.

impl From<InputMessageData> for EventData

fn from(data: InputMessageData) -> Self

Converts to this type from the input type.

impl From<LlmGenerationData> for EventData

fn from(data: LlmGenerationData) -> Self

Converts to this type from the input type.

impl From<OutputMessageCompletedData> for EventData

fn from(data: OutputMessageCompletedData) -> Self

Converts to this type from the input type.

impl From<OutputMessageDeltaData> for EventData

fn from(data: OutputMessageDeltaData) -> Self

Converts to this type from the input type.

impl From<OutputMessageReplacedData> for EventData

fn from(data: OutputMessageReplacedData) -> Self

Converts to this type from the input type.

impl From<OutputMessageStartedData> for EventData

fn from(data: OutputMessageStartedData) -> Self

Converts to this type from the input type.

impl From<ReasonCompletedData> for EventData

fn from(data: ReasonCompletedData) -> Self

Converts to this type from the input type.

impl From<ReasonItemData> for EventData

fn from(data: ReasonItemData) -> Self

Converts to this type from the input type.

impl From<ReasonStartedData> for EventData

fn from(data: ReasonStartedData) -> Self

Converts to this type from the input type.

impl From<ReasonThinkingCompletedData> for EventData

fn from(data: ReasonThinkingCompletedData) -> Self

Converts to this type from the input type.

impl From<ReasonThinkingDeltaData> for EventData

fn from(data: ReasonThinkingDeltaData) -> Self

Converts to this type from the input type.

impl From<ReasonThinkingStartedData> for EventData

fn from(data: ReasonThinkingStartedData) -> Self

Converts to this type from the input type.

impl From<SessionActivatedData> for EventData

fn from(data: SessionActivatedData) -> Self

Converts to this type from the input type.

impl From<SessionIdledData> for EventData

fn from(data: SessionIdledData) -> Self

Converts to this type from the input type.

impl From<SessionStartedData> for EventData

fn from(data: SessionStartedData) -> Self

Converts to this type from the input type.

impl From<SubagentEventData> for EventData

fn from(data: SubagentEventData) -> Self

Converts to this type from the input type.

impl From<ToolCallRequestedData> for EventData

fn from(data: ToolCallRequestedData) -> Self

Converts to this type from the input type.

impl From<ToolCompletedData> for EventData

fn from(data: ToolCompletedData) -> Self

Converts to this type from the input type.

impl From<ToolOutputDeltaData> for EventData

fn from(data: ToolOutputDeltaData) -> Self

Converts to this type from the input type.

impl From<ToolProgressData> for EventData

fn from(data: ToolProgressData) -> Self

Converts to this type from the input type.

impl From<ToolStartedData> for EventData

fn from(data: ToolStartedData) -> Self

Converts to this type from the input type.

impl From<TurnCancelledData> for EventData

fn from(data: TurnCancelledData) -> Self

Converts to this type from the input type.

impl From<TurnCompletedData> for EventData

fn from(data: TurnCompletedData) -> Self

Converts to this type from the input type.

impl From<TurnFailedData> for EventData

fn from(data: TurnFailedData) -> Self

Converts to this type from the input type.

impl From<TurnStartedData> for EventData

fn from(data: TurnStartedData) -> Self

Converts to this type from the input type.

impl From<VoiceSessionEndedData> for EventData

fn from(data: VoiceSessionEndedData) -> Self

Converts to this type from the input type.

impl From<VoiceSessionFailedData> for EventData

fn from(data: VoiceSessionFailedData) -> Self

Converts to this type from the input type.

impl From<VoiceSessionStartedData> for EventData

fn from(data: VoiceSessionStartedData) -> Self

Converts to this type from the input type.

impl Serialize for EventData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.