Skip to main content

Tool

Trait Tool 

Source
pub trait Tool: Send + Sync {
    // Required methods
    fn id(&self) -> &'static str;
    fn snippet(&self) -> &'static str;
    fn access(&self) -> Access;
    fn schema(&self) -> Value;
    fn docs(&self) -> &'static str;
    fn footprint(&self, args: &Value, root: &Path) -> Footprint;
    fn run<'life0, 'life1, 'async_trait>(
        &'life0 self,
        args: Value,
        cx: &'life1 ToolCx,
    ) -> Pin<Box<dyn Future<Output = Result<ToolOutput>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
}

Required Methods§

Source

fn id(&self) -> &'static str

Source

fn snippet(&self) -> &'static str

Tier 1: one line, always cheap.

Source

fn access(&self) -> Access

Source

fn schema(&self) -> Value

Tier 2: the JSON schema for the arguments, loaded on demand.

Source

fn docs(&self) -> &'static str

Tier 3: the manual.

Source

fn footprint(&self, args: &Value, root: &Path) -> Footprint

Source

fn run<'life0, 'life1, 'async_trait>( &'life0 self, args: Value, cx: &'life1 ToolCx, ) -> Pin<Box<dyn Future<Output = Result<ToolOutput>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§