Skip to main content

ChatResponseWriter

Struct ChatResponseWriter 

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

The sending side of a ChatResponseHandle, held by the Python bridge thread that drives the SDK’s async iterator.

Implementations§

Source§

impl ChatResponseWriter

Source

pub async fn send_text(&self, text: String) -> Result<(), WriterError>

Send a text token.

§Errors

Returns WriterError if the receiver has been dropped.

Source

pub async fn send_thought(&self, thought: String) -> Result<(), WriterError>

Send a thinking token.

§Errors

Returns WriterError if the receiver has been dropped.

Source

pub async fn send_tool_call( &self, event: ToolCallEvent, ) -> Result<(), WriterError>

Send a tool call event.

§Errors

Returns WriterError if the receiver has been dropped.

Source

pub async fn send_error(&self, error: StreamError) -> Result<(), WriterError>

Send an error.

§Errors

Returns WriterError if the receiver has been dropped.

Source

pub async fn send_event(&self, event: ResponseEvent) -> Result<(), WriterError>

Send a response event.

§Errors

Returns WriterError if the receiver has been dropped.

Source

pub async fn send_step(&self, step: Step) -> Result<(), WriterError>

Send a step.

§Errors

Returns WriterError if the receiver has been dropped.

Source

pub async fn send_chunk(&self, chunk: StreamChunk) -> Result<(), WriterError>

Send a unified stream chunk.

§Errors

Returns WriterError if the receiver has been dropped.

Source

pub fn set_usage(&self, usage: UsageMetadata)

Store usage metadata in the shared state so the handle can read it after the stream completes.

Source

pub fn set_structured_output(&self, value: Value)

Store structured output in the shared state so the handle can read it after the stream completes.

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<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, 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> Ungil for T
where T: Send,

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