Struct StreamWriter 

pub struct StreamWriter { /* private fields */ }

A streaming answer under construction, the bus’s completion writer. Obtained by Reply::written; finish ends the reply with the response it folds into, while a writer dropped without it leaves a truncated stream.

Implementations

impl StreamWriter

pub async fn text(&mut self, text: impl Into<String>) -> Result<(), SinkClosed>

A text fragment: extends the open text part, or opens one after closing an open reasoning part.

pub async fn reasoning( &mut self, text: impl Into<String>, ) -> Result<(), SinkClosed>

A reasoning fragment: extends the open reasoning part, or opens one after closing an open text part.

pub async fn tool_call( &mut self, name: impl Into<String>, arguments: Value, ) -> Result<(), SinkClosed>

A whole tool call, under an id rig issues.

pub fn raw(&mut self, raw: Value)

The reply’s provider document, the response’s raw.

pub fn request_id(&mut self, request_id: impl Into<String>)

The provider’s transport request id, the response’s provider_request_id: what a writer relaying a provider’s reply reports in place of a transport. An empty id is no id.

pub async fn error(&mut self, report: ErrorReport) -> Result<(), SinkClosed>

An in-band error: the consumer’s last item.

pub async fn finish(self, finish: Finish) -> Result<(), SinkClosed>

End the reply: closes the parts still open, then sends the response the reply folds into, under the writer’s origin. The returned stream ends when the writing future also finishes.

pub fn is_closed(&self) -> bool

Whether the consumer has closed the receiving side.