Enum StreamingEvent 

pub enum StreamingEvent {
    Start(StreamingStartEvent),
    Chunk(StreamingChunkEvent),
    Status(StreamingStatusEvent),
    Part(StreamingPartEvent),
    Citation(StreamingCitationEvent),
    State(StreamingStateEvent),
    SessionMeta(StreamingSessionMetaEvent),
    Tool(StreamingToolEvent),
    Complete(StreamingCompleteEvent),
    Error(StreamingErrorEvent),
}

NDJSON streaming event emitted by a plugin during response generation.

Serialized with a "type" discriminator: "start", "chunk", "complete", or "error". A well-formed response stream is: one Start → zero or more Chunk → one Complete (or Error at any point).

Variants

Start(StreamingStartEvent)

Marks the beginning of an assistant message’s stream.

Chunk(StreamingChunkEvent)

A partial text content chunk; multiple Chunks concatenate to the full text of the assistant’s primary text part.

Status(StreamingStatusEvent)

Transient progress indicator (e.g. thinking, analyzing). Streamed to the client but not persisted with the message.

Part(StreamingPartEvent)

Emits a complete typed message part (image/video/link/code/…) to append to the message document. Persisted with the message on finalize.

Citation(StreamingCitationEvent)

Mid-stream citations/references attached to a part (vs. the batch set on Complete). Persisted with that part on finalize.

State(StreamingStateEvent)

Opaque assistant-message state patch; merged into the message metadata.

SessionMeta(StreamingSessionMetaEvent)

Session-scoped metadata patch; merged into the owning session’s metadata.

Tool(StreamingToolEvent)

Tool-invocation trace (e.g. file search); recorded in message metadata.

Complete(StreamingCompleteEvent)

Stream completed successfully; may carry final metadata.

Error(StreamingErrorEvent)

Stream terminated with an error; no more events follow.

Trait Implementations

impl Clone for StreamingEvent

fn clone(&self) -> StreamingEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamingEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamingEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StreamingEvent

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.