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
impl<M: InputSender + 'static> Tool<M> for SleepUntilEventOrInputTool
fn name(&self) -> &str
fn description(&self) -> &str
fn parameters(&self) -> Value
Source§fn display_script(&self) -> Option<&str>
fn display_script(&self) -> Option<&str>
Optional Rhai script for pretty-printing this tool call.
Source§fn is_passive(&self) -> bool
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.
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,
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,
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§
impl Freeze for SleepUntilEventOrInputTool
impl RefUnwindSafe for SleepUntilEventOrInputTool
impl Send for SleepUntilEventOrInputTool
impl Sync for SleepUntilEventOrInputTool
impl Unpin for SleepUntilEventOrInputTool
impl UnsafeUnpin for SleepUntilEventOrInputTool
impl UnwindSafe for SleepUntilEventOrInputTool
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more