Enum StreamEvent 

pub enum StreamEvent {
    MessageStart {
        message: MessageMetadata,
    },
    ContentBlockStart {
        index: usize,
        content_block: ContentBlock,
    },
    ContentBlockDelta {
        index: usize,
        delta: ContentDelta,
    },
    ContentBlockStop {
        index: usize,
    },
    MessageDelta {
        delta: MessageDelta,
        usage: Usage,
    },
    MessageStop,
    Ping,
    Error {
        error: StreamError,
    },
}

Events emitted during streaming responses

Variants

MessageStart

Stream started - provides message metadata

Fields

message: MessageMetadata

ContentBlockStart

A content block has started

Fields

index: usize

content_block: ContentBlock

ContentBlockDelta

Delta update to a content block

Fields

index: usize

delta: ContentDelta

ContentBlockStop

A content block has finished

Fields

index: usize

MessageDelta

Delta update to the message (includes final usage)

Fields

delta: MessageDelta

usage: Usage

MessageStop

Stream has ended

Ping

Ping event (keepalive)

Error

Error event

Fields

error: StreamError

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.