Enum MessageStreamEvent 

pub enum MessageStreamEvent {
    Ping,
    MessageStart(MessageStartEvent),
    MessageDelta(MessageDeltaEvent),
    ContentBlockStart(ContentBlockStartEvent),
    ContentBlockDelta(ContentBlockDeltaEvent),
    ContentBlockStop(ContentBlockStopEvent),
    MessageStop(MessageStopEvent),
    ToolInputStart {
        tool_use_id: String,
        parameter_name: String,
    },
    ToolInputDelta {
        tool_use_id: String,
        parameter_name: String,
        value_fragment: String,
    },
    CompactionEvent(CompactionMetadata),
    StreamError {
        error: ApiError,
    },
}

Available on crate feature anthropic-client only.

An event in a message stream.

This enum represents all possible events that can occur when streaming messages from the Anthropic API. Events are delivered in a specific order: message_start, then potentially multiple content_block events, and finally message_stop.

Variants

Ping

A periodic ping event to keep the connection alive.

MessageStart(MessageStartEvent)

Indicates the start of a new message in the stream.

MessageDelta(MessageDeltaEvent)

Provides incremental updates to the message being generated.

ContentBlockStart(ContentBlockStartEvent)

Marks the beginning of a new content block within the message.

ContentBlockDelta(ContentBlockDeltaEvent)

Provides incremental updates to the current content block.

ContentBlockStop(ContentBlockStopEvent)

Indicates that the current content block is complete.

MessageStop(MessageStopEvent)

Marks the end of the message stream.

ToolInputStart

Fine-grained tool streaming: parameter start (Req 20).

Fields

tool_use_id: String

The tool use ID this parameter belongs to.

parameter_name: String

The name of the parameter being streamed.

ToolInputDelta

Fine-grained tool streaming: parameter delta (Req 20).

Fields

tool_use_id: String

The tool use ID this parameter belongs to.

parameter_name: String

The name of the parameter being streamed.

value_fragment: String

A fragment of the parameter value.

CompactionEvent(CompactionMetadata)

Compaction event during streaming (Req 3.8, 16.2).

StreamError

Stream error (Req 3.9).

Fields

error: ApiError

The error details.

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<MessageStreamEvent, <__D as Deserializer<'de>>::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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MessageStreamEvent