Skip to main content

ToolRoundCtx

Struct ToolRoundCtx 

Source
pub struct ToolRoundCtx<'a> {
    pub context: &'a RunContext,
    pub round: usize,
    pub registry: &'a ToolRegistry,
    pub state: &'a SharedState,
    pub events: &'a Option<Arc<dyn EventChannel>>,
}
Expand description

What a round policy gets handed to execute one tool round.

The agent constructs the context and passes it by value to your ToolRoundExecutor::execute_round; you only read it, and execute calls through run — the framework-owned per-call mechanics (span, events, registry dispatch) stay out of your hands, so a custom policy reorders / parallelizes / gates calls without reimplementing any of that. See ToolRoundExecutor for a working example.

Fields§

§context: &'a RunContext

Run context (the run id is the correlation key carried by spans and events).

§round: usize

The current round number (carried into the tool span).

§registry: &'a ToolRegistry

The tool registry (call dispatch + protected declarations).

§state: &'a SharedState

Shared state, injected into every tool call.

§events: &'a Option<Arc<dyn EventChannel>>

The observation channel (None when not attached).

Implementations§

Source§

impl ToolRoundCtx<'_>

Source

pub async fn run(&self, call: ToolCall) -> ToolCallOutcome

Dispatch one tool call with the framework’s standard mechanics and return its outcome.

Call this for each call your policy decides to run: the call is dispatched to the registry (tool span + ToolStarted / ToolCompleted events included), and the outcome carries immediate output text, a registry error text, or an effect request. Tool failures are not errors here; they ride along in content and are fed back to the model.

Takes &self rather than &mut self: the mechanics are all shared borrows, so a policy can hold multiple run futures concurrently (see the parallel example on with_tool_round_executor).

Trait Implementations§

Source§

impl Debug for ToolRoundCtx<'_>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for ToolRoundCtx<'a>

§

impl<'a> !UnwindSafe for ToolRoundCtx<'a>

§

impl<'a> Freeze for ToolRoundCtx<'a>

§

impl<'a> Send for ToolRoundCtx<'a>

§

impl<'a> Sync for ToolRoundCtx<'a>

§

impl<'a> Unpin for ToolRoundCtx<'a>

§

impl<'a> UnsafeUnpin for ToolRoundCtx<'a>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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: 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
Source§

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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