Skip to main content

AgentLoop

Struct AgentLoop 

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

AgentLoop.

Implementations§

Source§

impl AgentLoop

Source

pub fn new_with_resolver( provider: Arc<dyn Provider>, config: AgentLoopConfig, tools: Arc<ToolRegistry>, state: SharedState, resolver: Arc<dyn ProviderResolver>, ) -> Self

TODO. Create a new AgentLoop with an explicit resolver.

Source

pub fn new( provider: Arc<dyn Provider>, config: AgentLoopConfig, tools: Arc<ToolRegistry>, state: SharedState, ) -> Self

Create a new AgentLoop using the global resolver (backward compat).

Source

pub fn with_before_tool_call(self, hook: BeforeToolCallHook) -> Self

TODO: document this function.

Source

pub fn with_after_tool_call(self, hook: AfterToolCallHook) -> Self

TODO: document this function.

Source

pub fn steer(&self, message: Message)

Inject a steering message into the agent loop.

Steering messages are processed at the start of each turn, before the next LLM call. If the steering queue is at capacity (256 messages), the message is dropped and a warning is logged.

Source

pub fn follow_up(&self, message: Message)

Enqueue a follow-up message to continue the conversation after all tool calls in the current batch are complete.

If the follow-up queue is at capacity (64 messages), the message is dropped and a warning is logged.

Source

pub fn clear_steering_queue(&self)

TODO: document this function.

Source

pub fn clear_follow_up_queue(&self)

TODO: document this function.

Source

pub fn clear_all_queues(&self)

TODO: document this function.

Source

pub fn cancel_auto_retry(&self)

TODO: document this function.

Source

pub fn auto_retry_attempt(&self) -> usize

TODO: document this function.

Source

pub fn state(&self) -> &SharedState

Get a reference to the shared state. Used by Agent to sync state after loop execution.

Source

pub fn external_stop(&self) -> &Arc<AtomicBool>

Get the external stop flag.

Source

pub fn set_cancel_signal(&mut self, flag: Arc<AtomicBool>)

Sets a shared cancel signal (typically Agent::cancel_flag). The streaming loop checks this in its periodic wake-up timer, ensuring cancellation is detected even when the provider stream produces no events (e.g. waiting for first token).

Source

pub fn is_cancelled(&self) -> bool

Returns true if cancellation has been requested via either external_stop or the direct cancel_signal.

Source

pub fn cancel(&self)

Request cancellation from outside the loop (e.g. Ctrl+C). Sets the external_stop flag which causes the streaming loop to abort on its next periodic check (~500ms) and the agent loop to exit after the current turn.

Source

pub fn set_steering_hook( &mut self, hook: Arc<dyn Fn() -> Vec<String> + Send + Sync>, )

Set the steering hook — called each turn to drain new messages from the session’s steering queue into the loop’s internal queue.

Source

pub fn set_follow_up_hook( &mut self, hook: Arc<dyn Fn() -> Vec<String> + Send + Sync>, )

Set the follow-up hook — called each turn to drain new messages from the session’s follow-up queue into the loop’s internal queue.

Source

pub async fn run( &self, prompt: String, emit: impl Fn(AgentEvent) + Send + Sync + 'static, ) -> Result<Vec<AgentEvent>>

TODO: document this function.

Source

pub async fn run_messages( &self, prompts: Vec<Message>, emit: Arc<dyn Fn(AgentEvent) + Send + Sync>, ) -> Result<Vec<AgentEvent>>

TODO: document this function.

Source

pub async fn continue_loop( &self, emit: impl Fn(AgentEvent) + Send + Sync + 'static, ) -> Result<Vec<AgentEvent>>

TODO: document this function.

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<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