Struct StreamingCompletionResponse 

pub struct StreamingCompletionResponse {
    pub choice: Vec<AssistantContent>,
    pub response: Option<StreamFinal>,
    pub final_response_yielded: AtomicBool,
    pub message_id: Option<String>,
    /* private fields */
}

The response from a streaming completion request; message and response are populated at the end of the inner stream.

Fields

choice: Vec<AssistantContent>

The final aggregated message from the stream contains all text and tool calls generated

response: Option<StreamFinal>

The provider’s normalized terminal record, may be None if the provider didn’t yield it during the stream

final_response_yielded: AtomicBool

message_id: Option<String>

Provider-assigned message ID (e.g. OpenAI Responses API msg_ ID).

Implementations

impl StreamingCompletionResponse

pub fn stream(provider: impl Into<String>, inner: StreamingResult) -> Self

Wrap a provider stream and initialize aggregation state.

provider is the stable descriptor name of the provider producing the stream; it is recorded up front so it is available even when the stream never reaches its terminal record.

pub fn provider(&self) -> &str

Stable descriptor name of the provider producing this stream.

pub fn cancel(&mut self)

Cancel the stream and immediately drop the provider’s inner stream. Cancellation is surfaced as normal stream termination.

Cancelling also resumes a paused stream: a consumer parked on the pause channel must observe the termination instead of waiting forever for a resume that will never affect a stream that no longer exists.

pub fn pause(&self)

Pause stream polling.

pub fn resume(&self)

Resume stream polling after a pause.

pub fn is_paused(&self) -> bool

Returns whether the stream is currently paused.

pub fn usage(&self) -> Usage

Token usage reported by the provider for this response.

Returns the usage carried by the final response once the stream has produced it. Until then — or when the provider does not report streamed usage — this returns Usage::new, the zero-valued sentinel for missing usage metrics.

pub fn identity(&self) -> ResponseIdentity

This stream’s identity metadata as one crate::completion::ResponseIdentity carrier.

The message id is read from the stream rather than the terminal record: an explicit MessageId event outranks the terminal’s id, and the terminal record backfills the field when the stream never saw one. The response-scoped and transport ids exist only on the terminal record, so they stay None for a stream that ended without one.

Trait Implementations

impl From<StreamingCompletionResponse> for CompletionResponse

fn from(value: StreamingCompletionResponse) -> CompletionResponse

Converts to this type from the input type.

impl Stream for StreamingCompletionResponse

type Item = Result<StreamedAssistantContent, CompletionError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.