Struct StreamTextResult 

pub struct StreamTextResult<O> { /* private fields */ }

Result of a streaming call: one event stream plus a completion handle.

The stream must be consumed for the call to progress. Use split to forward events in one task and await the completion in another, or one of the consuming views.

Implementations

impl<O> StreamTextResult<O>

pub fn call_id(&self) -> &str

The call id.

pub fn split(self) -> (EventStream, Completion<O>)

Splits the result into the event stream and the completion handle.

pub fn events(&mut self) -> &mut EventStream

The event stream.

pub async fn consume(self) -> Result<GenerateTextResult<O>, Error>

Drains every event and returns the final result.

Errors

Returns the error that ended the call.

impl<O: Send + 'static> StreamTextResult<O>

pub fn text_stream(self) -> impl Stream<Item = Result<String, Error>> + Send

Consumes the result, yielding text deltas only. The final item is an error when the call failed.

pub fn partial_output_stream( self, ) -> impl Stream<Item = PartialOutput<O>> + Send

Consumes the result, yielding the structured output as it grows.

Only the first text part of each step is parsed; a value is published whenever the repaired partial JSON changes. Errors are not reported here: use consume or the completion for them.

impl<O> StreamTextResult<O>

where O: ArrayElements + Send + 'static, O::Element: DeserializeOwned + Send,

pub fn element_stream( self, ) -> impl Stream<Item = Result<O::Element, Error>> + Send

Consumes the result, yielding each element of an array output as soon as it is complete. The final item is an error when the call failed.

Trait Implementations

impl<O> Debug for StreamTextResult<O>

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

Formats the value using the given formatter.