Skip to main content

Engine

Struct Engine 

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

The core ReAct agent loop.

Drives an LLM through iterative reasoning and tool execution until the model produces a final text answer or the iteration limit is reached.

§Starting a turn

Every agent turn goes through Engine::run, which returns a RunBuilder. Chain axis setters (.ops, .cancel, .chunked) in any order, then call one of the three terminators (.result, .callback, .stream) to execute the turn:

use std::sync::Arc;
use motosan_agent_loop::{Engine, Message};

let agent = Arc::new(Engine::builder().build());

// Simplest: just the final result.
let result = Arc::clone(&agent)
    .run(llm.clone(), vec![Message::user("Hi!")])
    .result()
    .await?;

// Live token-by-token UI with AskUser support:
Arc::clone(&agent)
    .run(llm, vec![Message::user("Ask me a question")])
    .chunked()
    .ops(ops_rx)
    .callback(|event| println!("{event:?}"))
    .await?;

See RunBuilder for the full axis/terminator matrix and Engine::run for the entry point.

The loop does not own the LLM client; instead, RunBuilder takes Arc<dyn LlmClient> so the same loop can be reused with different backends.

Implementations§

Source§

impl Engine

Source

pub fn builder() -> EngineBuilder

Create a builder with default settings.

Source

pub fn channel_config(&self) -> &ChannelConfig

Returns the channel configuration for this agent loop.

Used by AgentSession to create bounded channels with the configured capacities and policies.

Source§

impl Engine

Source

pub fn run( self: Arc<Self>, llm: Arc<dyn LlmClient>, messages: Vec<Message>, ) -> RunBuilder

Build a run configuration for this agent.

Chain axis setters (.ops(rx), .cancel(token), .chunked()) in any order, then call one of the terminators (.result(), .callback(cb), .stream()) to execute the turn.

§Example
use std::sync::Arc;
use motosan_agent_loop::{Engine, Message};

let agent = Arc::new(Engine::builder().build());

// Simplest: just the final result.
let result = Arc::clone(&agent)
    .run(llm.clone(), vec![Message::user("Hi!")])
    .result()
    .await?;

See the RunBuilder struct documentation for the full set of axis setters and terminators.

Auto Trait Implementations§

§

impl !Freeze for Engine

§

impl !RefUnwindSafe for Engine

§

impl Send for Engine

§

impl Sync for Engine

§

impl Unpin for Engine

§

impl UnsafeUnpin for Engine

§

impl !UnwindSafe for Engine

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