Struct StreamEvent 

pub struct StreamEvent {
    pub message_start: Option<MessageStartEvent>,
    pub content_block_start: Option<ContentBlockStartEvent>,
    pub content_block_delta: Option<ContentBlockDeltaEvent>,
    pub content_block_stop: Option<ContentBlockStopEvent>,
    pub message_stop: Option<MessageStopEvent>,
    pub metadata: Option<MetadataEvent>,
    pub redact_content: Option<RedactContentEvent>,
    pub internal_server_exception: Option<ExceptionEvent>,
    pub model_stream_error_exception: Option<ModelStreamErrorEvent>,
    pub throttling_exception: Option<ExceptionEvent>,
    pub validation_exception: Option<ExceptionEvent>,
    pub service_unavailable_exception: Option<ExceptionEvent>,
}

A streaming event from the model.

Fields

message_start: Option<MessageStartEvent>

content_block_start: Option<ContentBlockStartEvent>

content_block_delta: Option<ContentBlockDeltaEvent>

content_block_stop: Option<ContentBlockStopEvent>

message_stop: Option<MessageStopEvent>

metadata: Option<MetadataEvent>

redact_content: Option<RedactContentEvent>

internal_server_exception: Option<ExceptionEvent>

model_stream_error_exception: Option<ModelStreamErrorEvent>

throttling_exception: Option<ExceptionEvent>

validation_exception: Option<ExceptionEvent>

service_unavailable_exception: Option<ExceptionEvent>

Implementations

impl StreamEvent

pub fn message_start(role: Role) -> Self

pub fn content_block_start(index: u32, start: Option<ContentBlockStart>) -> Self

pub fn content_block_delta(index: u32, delta: ContentBlockDelta) -> Self

pub fn text_delta(index: u32, text: impl Into<String>) -> Self

pub fn tool_use_delta(index: u32, input: impl Into<String>) -> Self

pub fn tool_use_start( index: u32, name: impl Into<String>, tool_use_id: impl Into<String>, ) -> Self

pub fn reasoning_delta(index: u32, text: impl Into<String>) -> Self

pub fn content_block_stop(index: u32) -> Self

pub fn message_stop(stop_reason: StopReason) -> Self

pub fn metadata(usage: Usage, metrics: Metrics) -> Self

pub fn is_text_delta(&self) -> bool

pub fn as_text_delta(&self) -> Option<&str>

pub fn is_message_stop(&self) -> bool

pub fn stop_reason(&self) -> Option<StopReason>

pub fn is_error(&self) -> bool

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

fn default() -> StreamEvent

Returns the “default value” for a type.

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