Enum ModelResponseStreamEvent 

pub enum ModelResponseStreamEvent {
    PartStart(PartStartEvent),
    PartDelta(PartDeltaEvent),
    PartEnd(PartEndEvent),
}

Stream event for model responses.

Variants

PartStart(PartStartEvent)

A new part has started.

PartDelta(PartDeltaEvent)

Delta for an existing part.

PartEnd(PartEndEvent)

A part has ended.

Implementations

impl ModelResponseStreamEvent

pub fn part_start( index: usize, part: ModelResponsePart, ) -> ModelResponseStreamEvent

Create a part start event.

pub fn text_delta( index: usize, content_delta: impl Into<String>, ) -> ModelResponseStreamEvent

Create a text delta event.

pub fn tool_call_delta( index: usize, args_delta: impl Into<String>, ) -> ModelResponseStreamEvent

Create a tool call delta event.

pub fn thinking_delta( index: usize, content_delta: impl Into<String>, ) -> ModelResponseStreamEvent

Create a thinking delta event.

pub fn builtin_tool_call_delta( index: usize, args_delta: impl Into<String>, ) -> ModelResponseStreamEvent

Create a builtin tool call delta event.

pub fn file_part(index: usize, part: FilePart) -> ModelResponseStreamEvent

Create a file part start event.

Files arrive complete (no deltas), so this creates a start event with the full file content.

pub fn builtin_tool_call_start( index: usize, part: BuiltinToolCallPart, ) -> ModelResponseStreamEvent

Create a builtin tool call start event.

pub fn part_end(index: usize) -> ModelResponseStreamEvent

Create a part end event.

pub fn index(&self) -> usize

Get the part index.

pub fn is_start(&self) -> bool

Check if this is a start event.

pub fn is_delta(&self) -> bool

Check if this is a delta event.

pub fn is_end(&self) -> bool

Check if this is an end event.

Trait Implementations

impl Clone for ModelResponseStreamEvent

fn clone(&self) -> ModelResponseStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelResponseStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModelResponseStreamEvent

fn deserialize<__D>( __deserializer: __D, ) -> Result<ModelResponseStreamEvent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ModelResponseStreamEvent

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

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 ModelResponseStreamEvent