Skip to main content

SleepUntilEventOrInputTool

Struct SleepUntilEventOrInputTool 

Source
pub struct SleepUntilEventOrInputTool;
Expand description

A no-op tool that signals the agent should wait indefinitely until an external event or user input arrives. The agent loop will simply stop after this tool is invoked, and resume when new input comes in.

Trait Implementations§

Source§

impl<M: InputSender + 'static> Tool<M> for SleepUntilEventOrInputTool

Source§

fn name(&self) -> &str

Source§

fn description(&self) -> &str

Source§

fn parameters(&self) -> Value

Source§

fn display_script(&self) -> Option<&str>

Optional Rhai script for pretty-printing this tool call.
Source§

fn is_passive(&self) -> bool

Whether a dispatched call to this tool represents waiting rather than in-flight work (e.g. the sleep tools). While a thread’s last history entry is an unanswered call to a non-passive tool, deferrable synthetic events are held back so they don’t interrupt the running call; calls to passive tools may be interrupted freely.
Source§

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, _args: Value, _id: ToolCallId, _call_id: Option<ProviderCallId>, _context: &'life1 ToolContext<M>, ) -> Pin<Box<dyn Future<Output = Result<(), Box<dyn Error + Send + Sync>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn supports_sync(&self) -> bool

Source§

fn execute_synchronous<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, _args: &'life1 Value, _id: &'life2 ToolCallId<str>, _call_id: Option<&'life3 ProviderCallId<str>>, _context: &'life4 ToolContext<M>, ) -> Pin<Box<dyn Future<Output = Option<ToolResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait,

Execute the tool synchronously, returning results that should be injected into the conversation history immediately. When this returns Some, execute will not be called — the returned messages are processed inline and the completion loop continues. This avoids race conditions where a concurrent event can make the tool call appear cancelled even though it already launched.

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: Sized + 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: Sized + 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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