Skip to main content

AgentHandle

Struct AgentHandle 

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

A handle to a spawned agent task.

Created via AgentHandle::spawn or AgentHandle::spawn_text, which move an Agent into a background tokio task. The handle allows the caller to poll status, cancel, and retrieve the final result.

Implementations§

Source§

impl AgentHandle

Source

pub fn spawn(agent: Agent, input: Vec<AgentMessage>) -> Self

Spawn an agent task with the given input messages.

Takes ownership of the Agent and moves it into a tokio task. Returns a handle that can be used to poll status, cancel, or await the result.

Source

pub fn spawn_text(agent: Agent, text: impl Into<String>) -> Self

Convenience wrapper that spawns an agent with a single text message.

Equivalent to calling spawn with a single UserMessage containing the given text.

Source

pub fn status(&self) -> AgentStatus

Returns the current status of the spawned agent task.

Source

pub fn is_done(&self) -> bool

Returns true if the agent task is no longer running.

Source

pub fn cancel(&self)

Request cancellation of the spawned agent task.

This is non-blocking. The task will transition to Cancelled status asynchronously.

Source

pub async fn result(self) -> Result<AgentResult, AgentError>

Consume the handle and await the final result.

If the task panicked, returns an AgentError::StreamError wrapping the panic message.

Source

pub fn try_result(&mut self) -> Option<Result<AgentResult, AgentError>>

Check if the task is finished and, if so, return the result without blocking.

Returns None if the task is still running. Once a result is returned, subsequent calls will return None.

Trait Implementations§

Source§

impl Debug for AgentHandle

Source§

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

Formats the value using the given formatter. 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<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: 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: 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> Same for T

Source§

type Output = T

Should always be Self
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