Skip to main content

ShellTools

Struct ShellTools 

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

The built-in tool set: bash. Shared behind an Arc between the engine’s Agent and the driver.

Implementations§

Source§

impl ShellTools

Source

pub fn builtin_specs() -> Vec<ToolSpec>

The specs the built-in tool set advertises. Fixed at compile time and independent of the instance: the system-prompt renderer names the same tools the resolver offers, so the prompt and the API’s tools array cannot drift.

Source

pub fn new(workspace: impl Into<PathBuf>) -> ShellTools

Tools rooted at workspace; the path is canonicalized, falling back to the input if canonicalization fails (canonicalization requires every component to exist).

Source

pub fn workspace(&self) -> &Path

The working directory every command starts in.

Source

pub fn install_approval(&self, approval: Arc<dyn Approval>)

Installs the approval hook consulted by the tool. Call once per turn before stepping; tool resolution cannot overlap another turn’s hook, so the swap is safe.

Source

pub fn clear_approval(&self)

Removes the approval hook; calls reject until one is installed again.

Trait Implementations§

Source§

impl ToolResolver for ShellTools

Source§

fn specs(&self) -> Vec<ToolSpec>

The tools offered to the model this step.
Source§

fn resolve<'life0, 'life1, 'async_trait>( &'life0 self, call: ToolCall, ctx: &'life1 ToolContext, ) -> Pin<Box<dyn Future<Output = ToolResult> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, ShellTools: 'async_trait,

Turn a model’s call into a result. Errors become in-band results: implementations must not panic and must not abort on unknown names or bad arguments — return ToolResult::failure instead.
Source§

fn resolve_streaming<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, call: ToolCall, ctx: &'life1 ToolContext, progress: &'life2 mut (dyn for<'a> FnMut(&'a str) + Send), ) -> Pin<Box<dyn Future<Output = ToolResult> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, ShellTools: 'async_trait,

Resolve with progress: an implementation running something long — a shell command — calls progress with human-facing output chunks (complete lines) as they land, so a sink can render them live; the full text still arrives in the returned result. The default ignores progress and resolves as usual.
Source§

fn replay_safety(&self, _name: &str) -> ReplaySafety

The replay safety of one offered tool (see ReplaySafety), consulted when a crash left a committed call without its result. Defaults to ReplaySafety::Unsafe: a resolver that does not classify its tools is treated as entirely side-effecting.

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

Source§

type Output = T

Should always be Self
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