Enum KnownStreamEvent 

#[non_exhaustive]
pub enum KnownStreamEvent {
    MessageStart {
        message: Message,
    },
    ContentBlockStart {
        index: u32,
        content_block: ContentBlock,
    },
    ContentBlockDelta {
        index: u32,
        delta: ContentDelta,
    },
    ContentBlockStop {
        index: u32,
    },
    MessageDelta {
        delta: MessageDelta,
        usage: Usage,
    },
    MessageStop,
    Ping,
    Error {
        error: ApiErrorPayload,
    },
}

All streaming event types known to this SDK version.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MessageStart

Begins a new streamed message; carries the empty Message shell that subsequent events will fill in.

Fields

message: Message

The opening message snapshot.

ContentBlockStart

Begins a new content block within the message.

Fields

index: u32

Index of the block within the message’s content array.

content_block: ContentBlock

Initial state of the block.

ContentBlockDelta

Incremental update to a content block.

Fields

index: u32

Index of the block being updated.

delta: ContentDelta

The delta payload.

ContentBlockStop

Marks a content block as complete.

Fields

index: u32

Index of the block that finished.

MessageDelta

Late-arriving updates to message-level fields, plus final usage.

Fields

delta: MessageDelta

Updated message-level fields.

usage: Usage

Cumulative usage at the point this delta was emitted.

MessageStop

Final event in a successful stream.

Ping

Keep-alive ping; no payload.

Error

Server reported a fatal error mid-stream.

Fields

error: ApiErrorPayload

The error payload.

Trait Implementations

impl Clone for KnownStreamEvent

fn clone(&self) -> KnownStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KnownStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KnownStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<KnownStreamEvent> for StreamEvent

fn from(k: KnownStreamEvent) -> Self

Converts to this type from the input type.

impl PartialEq for KnownStreamEvent

fn eq(&self, other: &KnownStreamEvent) -> 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 KnownStreamEvent

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 KnownStreamEvent