Skip to main content

LoopInterrupt

Enum LoopInterrupt 

Source
pub enum LoopInterrupt {
    ApprovalRequest(PendingApproval),
    AwaitingInput(InputRequest),
    AfterToolResult(ToolRoundInfo),
}
Expand description

An interrupt that pauses the agent loop until the host resolves it.

The loop returns an interrupt inside LoopStep::Interrupt whenever it cannot proceed autonomously. Each variant carries a handle with resolution methods so callers can resolve the interrupt directly.

§Example

use agentkit_loop::{LoopInterrupt, LoopStep};

match driver.next().await? {
    LoopStep::Interrupt(LoopInterrupt::ApprovalRequest(pending)) => {
        println!("Tool {} needs approval: {}", pending.request.request_kind, pending.request.summary);
        pending.approve(driver)?;
    }
    LoopStep::Interrupt(LoopInterrupt::AwaitingInput(pending)) => {
        println!("Waiting for input: {}", pending.reason);
        // ... call pending.submit(driver, items)
    }
    LoopStep::Interrupt(LoopInterrupt::AfterToolResult(info)) => {
        // Cooperative yield between tool rounds.  Optionally call
        // driver.submit_input(...) to interject a user message, then
        // call driver.next() to resume the turn.
        let _ = info;
    }
    LoopStep::Finished(result) => {
        println!("Turn finished: {:?}", result.finish_reason);
    }
}

Variants§

§

ApprovalRequest(PendingApproval)

A tool call requires explicit approval before it can execute.

§

AwaitingInput(InputRequest)

The driver has no pending input and needs the host to supply some.

§

AfterToolResult(ToolRoundInfo)

A tool round finished: all tool calls from the previous assistant message now have results in the transcript, and the driver is about to invoke the model again. The host may interject user messages via the ToolRoundInfo::submit handle before calling LoopDriver::next to resume.

This is a non-blocking interrupt: callers that do not care about mid-turn interjection can treat it as a no-op (_ => continue) and the next next() call resumes the turn.

Implementations§

Source§

impl LoopInterrupt

Source

pub fn is_blocking(&self) -> bool

Returns true if the interrupt must be explicitly resolved before the loop can make progress. Approvals are blocking; AwaitingInput and AfterToolResult are cooperative and can be ignored by calling LoopDriver::next again.

Trait Implementations§

Source§

impl Clone for LoopInterrupt

Source§

fn clone(&self) -> LoopInterrupt

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 Debug for LoopInterrupt

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for LoopInterrupt

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for LoopInterrupt

Source§

fn eq(&self, other: &LoopInterrupt) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for LoopInterrupt

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for LoopInterrupt

Source§

impl StructuralPartialEq for LoopInterrupt

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,