Struct StreamEvent 

#[non_exhaustive]
pub struct StreamEvent {
    pub chunk: StreamChunk,
    pub event_id: Option<String>,
}

A streaming event with position metadata for resume support.

This wrapper pairs a StreamChunk with its event_id, enabling stream resumption after network interruptions. To resume a stream, pass the event_id from the last successfully received event to resume the stream.

Example

let mut last_event_id = None;
let mut stream = client.interaction().with_model("gemini-3-flash-preview")
    .with_text("Count to 100").create_stream();

while let Some(result) = stream.next().await {
    let event = result?;
    last_event_id = event.event_id.clone();  // Track for resume
    match event.chunk {
        StreamChunk::Delta(content) => { /* process */ }
        StreamChunk::Complete(response) => { /* done */ }
        _ => {}
    }
}

// If interrupted, resume from last_event_id:
let resumed_stream = client.get_interaction_stream(&interaction_id, last_event_id.as_deref());

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

chunk: StreamChunk

The chunk content (Delta, Complete, or Unknown).

event_id: Option<String>

Event ID for stream resumption.

Pass this to last_event_id when calling get_interaction_stream() to resume the stream from this point. Events are ordered, so resuming from an event_id will replay all subsequent events.

Implementations

impl StreamEvent

pub fn new(chunk: StreamChunk, event_id: Option<String>) -> Self

Creates a new StreamEvent with the given chunk and event_id.

pub const fn is_delta(&self) -> bool

Returns true if the chunk is a Delta variant.

pub const fn is_complete(&self) -> bool

Returns true if the chunk is a Complete variant.

pub const fn is_unknown(&self) -> bool

Returns true if the chunk is an Unknown variant.

pub const fn is_terminal(&self) -> bool

Returns true if the chunk is a terminal event (Complete or Error).

pub fn interaction_id(&self) -> Option<&str>

Returns the interaction ID from the chunk, if available.

pub fn status(&self) -> Option<&InteractionStatus>

Returns the status from the chunk, if available.

pub fn unknown_chunk_type(&self) -> Option<&str>

Returns the unrecognized chunk type if this is an Unknown variant.

pub fn unknown_data(&self) -> Option<&Value>

Returns the preserved JSON data if this is an Unknown variant.

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.