Struct StreamEvent 

pub struct StreamEvent {
    pub event_type: StreamEventType,
    pub timestamp: u64,
    pub content: Option<String>,
    pub tool_call: Option<ToolCallData>,
    pub metadata: HashMap<String, String>,
    pub error: Option<String>,
    pub is_reasoning: bool,
    pub agent_id: Option<String>,
    pub session_id: Option<String>,
    pub run_id: Option<String>,
}

A single streaming event emitted during LLM response streaming.

Fields

event_type: StreamEventType

Event type

timestamp: u64

Timestamp (milliseconds since epoch)

content: Option<String>

Text content for DeltaText events

tool_call: Option<ToolCallData>

Tool call data for DeltaToolCall events

metadata: HashMap<String, String>

Additional metadata

error: Option<String>

Error message for Error events

is_reasoning: bool

Whether this is reasoning/thinking content

agent_id: Option<String>

Agent ID for multi-agent scenarios

session_id: Option<String>

Session ID for tracking

run_id: Option<String>

Run ID for correlation

Implementations

impl StreamEvent

pub fn new(event_type: StreamEventType) -> Self

Create a new stream event

pub fn content(self, content: impl Into<String>) -> Self

Set content

pub fn tool_call(self, tool_call: ToolCallData) -> Self

Set tool call

pub fn error(self, error: impl Into<String>) -> Self

Set error

pub fn reasoning(self, is_reasoning: bool) -> Self

Set as reasoning content

pub fn agent_id(self, id: impl Into<String>) -> Self

Set agent ID

pub fn session_id(self, id: impl Into<String>) -> Self

Set session ID

pub fn run_id(self, id: impl Into<String>) -> Self

Set run ID

pub fn metadata(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add metadata

pub fn request_start() -> Self

Create a request start event

pub fn first_token(content: impl Into<String>) -> Self

Create a first token event

pub fn delta_text(content: impl Into<String>) -> Self

Create a delta text event

pub fn stream_end() -> Self

Create a stream end event

pub fn error_event(message: impl Into<String>) -> Self

Create an error event

Trait Implementations

impl Clone for StreamEvent

fn clone(&self) -> StreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StreamEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.