Skip to main content

Runner

Struct Runner 

Source
pub struct Runner<A> { /* private fields */ }
Expand description

A configured run: the agent, its transformer chain and its cancellation token.

let runner = Runner::new(MyAgent).transformer(FilterToolCalls::deny(["internal_debug"]));
let token = runner.cancellation_token();   // hand this to the transport
let stream = runner.run(RunAgentInput::new("thread-1", "run-1"));

Implementations§

Source§

impl<A> Runner<A>

Source

pub fn new(agent: A) -> Self

Wraps an agent.

Source

pub fn transformer(self, transformer: impl StreamTransformer + 'static) -> Self

Appends a transformer to the chain. See StreamTransformer.

Source

pub fn transformers(self, chain: TransformerChain) -> Self

Replaces the whole transformer chain.

Source

pub fn cancellation(self, token: CancellationToken) -> Self

Uses an existing cancellation token instead of the fresh one.

Source

pub fn cancellation_token(&self) -> CancellationToken

A handle on this run’s cancellation, for the transport to trip when the client disconnects.

Source

pub fn echo_input(self, echo: bool) -> Self

Echoes the request back on RUN_STARTED, so a recorded stream replays without the original HTTP body. Off by default — it is the largest payload in the protocol.

Source§

impl<A: Agent> Runner<A>

Source

pub fn run( self, input: RunAgentInput, ) -> impl Stream<Item = Result<Event>> + Send

Starts the run.

The returned stream emits RUN_STARTED first and exactly one of RUN_FINISHED / RUN_ERROR last — including when the agent body does nothing, and when it returns Err through a ?.

A panic inside the agent is not caught; it unwinds through whoever is polling the stream, as it would through any other future. Use the transport’s own panic handling if you need a response body for that case.

Trait Implementations§

Source§

impl<A> Debug for Runner<A>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<A> !RefUnwindSafe for Runner<A>

§

impl<A> !Sync for Runner<A>

§

impl<A> !UnwindSafe for Runner<A>

§

impl<A> Freeze for Runner<A>
where A: Freeze,

§

impl<A> Send for Runner<A>
where A: Send,

§

impl<A> Unpin for Runner<A>
where A: Unpin,

§

impl<A> UnsafeUnpin for Runner<A>
where A: UnsafeUnpin,

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.

§

impl<T> Instrument for T

§

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

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

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.

§

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

§

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
§

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, 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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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