Skip to main content

StreamAccumulator

Struct StreamAccumulator 

Source
pub struct StreamAccumulator { /* private fields */ }
Expand description

Rebuilds one Response from a stream of WireStreamEvents.

This is the receiving half of the proxy pattern: the client-side equivalent of RequestBuilder::stream_accumulated, operating on events that arrived over a network rather than on a live provider connection.

Unlike stream_accumulated, this does reassemble tool calls: fragments from ToolCallStart / ToolCallDelta / ToolCallEnd are concatenated and attached to the assistant message.

§Truncation is an error

finish fails unless the stream was well-formed: it must have opened with MessageStart and ended with a terminal event. A stream that just stops — the client’s socket died mid-generation — yields WireErrorKind::Stream, which is what distinguishes “the network died” from “the provider refused” (the latter arrives as WireStreamEvent::Error and is returned as its own WireError).

§Examples

use rai_sdk::ProviderKind;
use rai_sdk::wire::{StreamAccumulator, WireStreamEvent};

let mut accumulator = StreamAccumulator::new();
accumulator.push(WireStreamEvent::message_start("gpt-4o-mini", ProviderKind::OpenAI))?;
accumulator.push(WireStreamEvent::TextDelta { text: "done".into() })?;
accumulator.push(WireStreamEvent::MessageStop { finish_reason: Some("stop".into()) })?;

let response = accumulator.finish()?;
assert_eq!(response.text(), "done");
assert_eq!(response.finish_reason.as_deref(), Some("stop"));

Implementations§

Source§

impl StreamAccumulator

Source

pub fn new() -> Self

Start with an empty accumulator.

Source

pub fn protocol_version(&self) -> Option<u32>

The protocol version the sender advertised, once MessageStart has been seen.

Source

pub fn text(&self) -> &str

The assistant text accumulated so far.

Source

pub fn usage(&self) -> Option<&Usage>

Token usage, once a Usage event has arrived.

Source

pub fn is_complete(&self) -> bool

Whether a terminal event has been seen.

A stream whose events are exhausted while this is false was truncated.

Source

pub fn push(&mut self, event: WireStreamEvent) -> Result<(), WireError>

Absorb one event.

§Errors

Returns the carried WireError when event is WireStreamEvent::Error, so a caller driving this in a loop can stop with ?. The error is remembered, so a later finish reports it too.

Source

pub fn finish(self) -> Result<Response, WireError>

Assemble everything pushed so far into one Response.

§Errors
Source

pub async fn accumulate<S>(stream: S) -> Result<Response, WireError>
where S: Stream<Item = WireStreamEvent>,

Drain a stream of wire events into one Response.

The convenience form of new() + push() in a loop + finish(), for the common client-side case where the whole stream is consumed at once.

§Errors

Same as push and finish.

§Examples
use rai_sdk::ProviderKind;
use rai_sdk::wire::{StreamAccumulator, WireStreamEvent};

let events = futures::stream::iter(vec![
    WireStreamEvent::message_start("claude-sonnet-4-6", ProviderKind::Anthropic),
    WireStreamEvent::TextDelta { text: "hi".into() },
    WireStreamEvent::MessageStop { finish_reason: Some("stop".into()) },
]);

let response = StreamAccumulator::accumulate(events).await?;
assert_eq!(response.text(), "hi");

Trait Implementations§

Source§

impl Clone for StreamAccumulator

Source§

fn clone(&self) -> StreamAccumulator

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamAccumulator

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for StreamAccumulator

Source§

fn default() -> StreamAccumulator

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more