Skip to main content

TurnResult

Enum TurnResult 

Source
pub enum TurnResult<'a, 'h, Ctx: LoopDepth + Send + Sync + 'static> {
    Yielded(Yielded<'a, 'h, Ctx>),
    Completed(Completed),
    Error(TurnError),
}
Expand description

Result of one turn of the tool loop.

Match on this to determine what happened and what you can do next. Each variant carries the data from the turn AND (for Yielded) a handle scoped to valid operations for that state.

This follows the same pattern as std::collections::hash_map::Entry — the variant gives you exactly the methods that make sense for that state.

Variants§

§

Yielded(Yielded<'a, 'h, Ctx>)

Tools were executed. The caller MUST consume this via resume(), continue_loop(), inject_and_continue(), or stop().

While this variant exists, the ToolLoopHandle is mutably borrowed and cannot be used directly. Consuming the Yielded releases the borrow.

§

Completed(Completed)

The loop completed (no tool calls, stop condition, max iterations, or timeout).

§

Error(TurnError)

An unrecoverable error occurred.

Auto Trait Implementations§

§

impl<'a, 'h, Ctx> Freeze for TurnResult<'a, 'h, Ctx>

§

impl<'a, 'h, Ctx> !RefUnwindSafe for TurnResult<'a, 'h, Ctx>

§

impl<'a, 'h, Ctx> Send for TurnResult<'a, 'h, Ctx>

§

impl<'a, 'h, Ctx> Sync for TurnResult<'a, 'h, Ctx>

§

impl<'a, 'h, Ctx> Unpin for TurnResult<'a, 'h, Ctx>

§

impl<'a, 'h, Ctx> !UnwindSafe for TurnResult<'a, 'h, Ctx>

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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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