Skip to main content

Yielded

Struct Yielded 

Source
pub struct Yielded<'a, 'h, Ctx: LoopDepth + Send + Sync + 'static> {
    pub tool_calls: Vec<ToolCall>,
    pub results: Vec<ToolResult>,
    pub assistant_content: Vec<ContentBlock>,
    pub iteration: u32,
    pub total_usage: Usage,
    pub events: Vec<LoopEvent>,
    /* private fields */
}
Expand description

Handle returned when tools were executed. Borrows the ToolLoopHandle mutably, so the caller cannot call next_turn() again until this is consumed via resume(), continue_loop(), inject_and_continue(), or stop().

The text content the LLM produced alongside tool calls is available directly via assistant_content and assistant_text() — no need to scan messages().

Fields§

§tool_calls: Vec<ToolCall>

The tool calls the LLM requested.

§results: Vec<ToolResult>

Results from executing those tool calls.

§assistant_content: Vec<ContentBlock>

Text content from the LLM’s response alongside the tool calls.

This is the other_content from partition_content()Text, Reasoning, Image, etc. — everything that isn’t a ToolCall or ToolResult. Previously only accessible by scanning messages().

§iteration: u32

Current iteration number (1-indexed).

§total_usage: Usage

Accumulated usage across all iterations so far.

§events: Vec<LoopEvent>

Lifecycle events from this turn (IterationStart, ToolExecutionStart/End, etc.).

Pre-drained from the internal buffer — no need to call ToolLoopHandle::drain_events() separately.

Implementations§

Source§

impl<'a, 'h, Ctx: LoopDepth + Send + Sync + 'static> Yielded<'a, 'h, Ctx>

Source

pub fn resume(self, command: LoopCommand)

Continue with the given command.

Source

pub fn continue_loop(self)

Convenience: continue to the next LLM iteration with no injected messages.

Source

pub fn inject_and_continue(self, messages: Vec<ChatMessage>)

Convenience: inject messages and continue.

Source

pub fn stop(self, reason: Option<String>)

Convenience: stop the loop.

Source

pub fn assistant_text(&self) -> Option<String>

Extract text from assistant_content blocks.

Returns the LLM’s “thinking aloud” text emitted alongside tool calls, or None if there were no text blocks.

Source

pub fn messages(&self) -> &[ChatMessage]

Access the full message history (read-only).

Source

pub fn messages_mut(&mut self) -> &mut Vec<ChatMessage>

Access the full message history (mutable, for context compaction).

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<'a, 'h, Ctx> !UnwindSafe for Yielded<'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