Struct AgentStream 

pub struct AgentStream { /* private fields */ }

Streaming agent execution.

This provides real streaming by spawning a task that streams from the model and sends events through a channel.

Cancellation

Use AgentStream::new_with_cancel to create a stream with cancellation support. When the cancellation token is triggered, the stream will:

1. Stop the model stream
2. Cancel any pending tool calls
3. Emit a AgentStreamEvent::Cancelled event with partial results

Implementations

impl AgentStream

pub async fn new<Deps, Output>( agent: &Agent<Deps, Output>, prompt: UserContent, deps: Deps, options: RunOptions, ) -> Result<Self, AgentRunError>

where Deps: Send + Sync + 'static, Output: Send + Sync + 'static,

Create a new streaming agent run.

This spawns a background task that handles the actual streaming and tool execution.

pub async fn new_with_cancel<Deps, Output>( agent: &Agent<Deps, Output>, prompt: UserContent, deps: Deps, options: RunOptions, cancel_token: CancellationToken, ) -> Result<Self, AgentRunError>

where Deps: Send + Sync + 'static, Output: Send + Sync + 'static,

Create a new streaming agent run with cancellation support.

The provided CancellationToken can be used to cancel the agent run mid-execution. When cancelled:

• The model stream is stopped
• In-flight tool calls are aborted
• A Cancelled event is emitted with partial results

Example

use tokio_util::sync::CancellationToken;

let cancel_token = CancellationToken::new();
let stream = AgentStream::new_with_cancel(
    &agent,
    "Hello!".into(),
    deps,
    RunOptions::default(),
    cancel_token.clone(),
).await?;

// Cancel from another task
cancel_token.cancel();

pub fn cancel(&self)

Cancel the running agent stream.

If this stream was created with cancellation support via AgentStream::new_with_cancel, this will trigger cancellation. The stream will emit a Cancelled event with any partial results.

If this stream was created without cancellation support (via new), this method does nothing.

pub fn is_cancelled(&self) -> bool

Check if this stream was cancelled.

Returns true if a cancellation token was provided and it has been triggered, false otherwise.

pub fn cancellation_token(&self) -> Option<&CancellationToken>

Get the cancellation token if one was provided.

This can be used to share the token with other tasks that need to coordinate cancellation.

Trait Implementations

impl Stream for AgentStream

type Item = Result<AgentStreamEvent, AgentRunError>

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.