Enum StreamEvent 

pub enum StreamEvent {
    MessageStart {
        id: String,
        model: String,
    },
    ContentBlockStart {
        index: u32,
        content_type: StreamingContentType,
    },
    Delta {
        index: u32,
        delta: StreamingDelta,
    },
    ContentBlockStop {
        index: u32,
    },
    MessageDelta {
        stop_reason: Option<StopReason>,
        usage_delta: Option<Usage>,
    },
    MessageStop,
    Ping,
}

A single event in a streaming completion.

Variants

MessageStart

The message has started; carries the assigned ID and model.

Fields

id: String

Provider-assigned message identifier.

model: String

Model that is generating the message.

ContentBlockStart

A content block is starting at the given index.

Fields

index: u32

Zero-based block index.

content_type: StreamingContentType

The type of content block that is starting.

Delta

An incremental delta for the block at the given index.

Fields

index: u32

Zero-based block index.

delta: StreamingDelta

The incremental content.

ContentBlockStop

The content block at the given index is complete.

Fields

index: u32

Zero-based block index.

MessageDelta

End-of-message metadata delta.

Fields

stop_reason: Option<StopReason>

Why the model stopped, if known.

usage_delta: Option<Usage>

Incremental usage update.

MessageStop

The message is fully complete.

Ping

A keep-alive ping from the provider.

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 PartialEq for StreamEvent

fn eq(&self, other: &StreamEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for StreamEvent