Enum StreamEvent 

pub enum StreamEvent<T> {
    Data(T),
    Progress(StreamProgress),
    BatchComplete {
        batch_id: u64,
        count: usize,
    },
    Error(StreamError),
    Complete(StreamSummary),
}

Events emitted during streaming generation.

Variants

Data(T)

A data item was generated.

Progress(StreamProgress)

Progress update.

BatchComplete

A batch of items was completed.

Fields

batch_id: u64

Batch identifier.

count: usize

Number of items in the batch.

Error(StreamError)

An error occurred (non-fatal, generation continues).

Complete(StreamSummary)

Generation is complete.

Implementations

impl<T> StreamEvent<T>

pub fn is_data(&self) -> bool

Returns true if this is a data event.

pub fn is_complete(&self) -> bool

Returns true if this is a completion event.

pub fn is_error(&self) -> bool

Returns true if this is an error event.

pub fn into_data(self) -> Option<T>

Extracts data from a Data event.

Trait Implementations

impl<T: Clone> Clone for StreamEvent<T>

fn clone(&self) -> StreamEvent<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for StreamEvent<T>

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

Formats the value using the given formatter.