Enum MessageStreamEvent 

pub enum MessageStreamEvent {
    MessageStart {
        message: Message,
    },
    MessageDelta {
        delta: MessageDelta,
        usage: MessageDeltaUsage,
    },
    MessageStop,
    ContentBlockStart {
        content_block: ContentBlock,
        index: usize,
    },
    ContentBlockDelta {
        delta: ContentBlockDelta,
        index: usize,
    },
    ContentBlockStop {
        index: usize,
    },
}

Main stream event type that encompasses all possible streaming events.

This is the primary type you’ll work with when processing streaming responses. Each event represents a different stage of the message generation process.

Variants

MessageStart

Initial event when a message starts being generated.

Contains the initial message structure with metadata but no content yet.

Fields

message: Message

The initial message structure

MessageDelta

Event when the message metadata is updated during generation.

Contains updates to stop reason, stop sequence, and usage information.

Fields

delta: MessageDelta

The delta containing updated fields

usage: MessageDeltaUsage

Current usage statistics

MessageStop

Final event when message generation is complete.

ContentBlockStart

Event when a new content block starts being generated.

This occurs when Claude begins generating a new piece of content (text, tool use, etc.).

Fields

content_block: ContentBlock

The content block being started

index: usize

Index of this content block in the message

ContentBlockDelta

Event containing incremental updates to a content block.

This is where you’ll receive the actual text being generated, tool input being parsed, etc.

Fields

delta: ContentBlockDelta

The incremental update

index: usize

Index of the content block being updated

ContentBlockStop

Event when a content block finishes generation.

Fields

index: usize

Index of the content block that finished

Trait Implementations

impl Clone for MessageStreamEvent

fn clone(&self) -> MessageStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MessageStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MessageStreamEvent

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

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 MessageStreamEvent