Skip to main content

EngineHandle

Struct EngineHandle 

Source
pub struct EngineHandle<P, R> {
    pub tx_op: Sender<Op>,
    pub rx_event: Arc<RwLock<Receiver<Event>>>,
    /* private fields */
}
Expand description

Handle to communicate with the engine.

Fields§

§tx_op: Sender<Op>

Send operations to the engine.

§rx_event: Arc<RwLock<Receiver<Event>>>

Receive events from the engine.

Implementations§

Source§

impl<P, R> EngineHandle<P, R>
where P: Send + Sync + 'static, R: Send + Sync + 'static,

Source

pub fn new( tx_op: Sender<Op>, rx_event: Arc<RwLock<Receiver<Event>>>, cancel_token: Arc<StdMutex<CancellationToken>>, tx_approval: Sender<ApprovalDecision<P>>, tx_user_input: Sender<UserInputDecision<R>>, tx_steer: Sender<String>, ) -> Self

Construct a new handle. Intended for the engine’s bootstrap path; the returned handle is Clone, so the runtime/UI layer copies it cheaply.

Source

pub async fn send(&self, op: Op) -> Result<()>

Send an operation to the engine.

Source

pub fn cancel(&self)

Cancel the current request.

Source

pub fn is_cancelled(&self) -> bool

Check if a request is currently cancelled.

Source

pub async fn approve_tool_call(&self, id: impl Into<String>) -> Result<()>

Approve a pending tool call.

Source

pub async fn approve_tool_call_with_options( &self, id: impl Into<String>, cache_key: Option<String>, remember_for_session: bool, ) -> Result<()>

Approve a pending tool call and optionally remember the decision for the session.

Source

pub async fn deny_tool_call(&self, id: impl Into<String>) -> Result<()>

Deny a pending tool call.

Source

pub async fn retry_tool_with_policy( &self, id: impl Into<String>, policy: P, ) -> Result<()>

Retry a tool call with an elevated sandbox policy.

Source

pub async fn submit_user_input( &self, id: impl Into<String>, response: R, ) -> Result<()>

Submit a response for request_user_input.

Source

pub async fn cancel_user_input(&self, id: impl Into<String>) -> Result<()>

Cancel a request_user_input prompt.

Source

pub async fn steer(&self, content: impl Into<String>) -> Result<()>

Steer an in-flight turn with additional user input.

Source

pub async fn query_context_snapshot(&self) -> Result<ThreadContextSnapshot>

Query TUI-aligned context usage from the live engine session.

Source

pub async fn query_harness_task_graph(&self) -> Result<Value>

Query derived long-horizon task graph from the live engine session.

Source

pub async fn query_harness_cycles(&self) -> Result<Value>

Query cycle briefings and archive metadata from the live engine session.

Source

pub async fn truncate_before_last_user_message(&self) -> Result<bool>

Remove the last user message and everything after it (F4 / #383).

Trait Implementations§

Source§

impl<P: Clone, R: Clone> Clone for EngineHandle<P, R>

Source§

fn clone(&self) -> EngineHandle<P, R>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<P, R> TurnEnginePort for EngineHandle<P, R>
where P: Send + Sync + 'static, R: Send + Sync + 'static,

Source§

fn start_turn<'life0, 'async_trait>( &'life0 self, params: StartTurnParams, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn cancel_active_turn(&self)

Auto Trait Implementations§

§

impl<P, R> !RefUnwindSafe for EngineHandle<P, R>

§

impl<P, R> !UnwindSafe for EngineHandle<P, R>

§

impl<P, R> Freeze for EngineHandle<P, R>

§

impl<P, R> Send for EngineHandle<P, R>
where P: Send, R: Send,

§

impl<P, R> Sync for EngineHandle<P, R>
where P: Send, R: Send,

§

impl<P, R> Unpin for EngineHandle<P, R>

§

impl<P, R> UnsafeUnpin for EngineHandle<P, R>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<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