Struct MockControlledTool 

pub struct MockControlledTool {
    pub started: Arc<Notify>,
    pub allow_finish: Arc<Notify>,
}

Available on crate feature test-utils only.

A mock tool that notifies when started and waits for an explicit finish signal.

Fields

started: Arc<Notify>

Notified when a tool call starts.

allow_finish: Arc<Notify>

Waited on before a tool call finishes.

Implementations

impl MockControlledTool

pub fn new(started: Arc<Notify>, allow_finish: Arc<Notify>) -> Self

Create a controlled tool from notification primitives.

Trait Implementations

impl Clone for MockControlledTool

fn clone(&self) -> MockControlledTool

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Tool for MockControlledTool

const NAME: &'static str = "controlled"

The name of the tool. This name should be unique within a single ToolSet or other registration scope that dispatches tools by name.

type Error = MockToolError

The error type of the tool.

type Args = Value

The arguments type of the tool.

type Output = i32

The output type of the tool.

fn description(&self) -> String

Model-facing description of what the tool does.

fn parameters(&self) -> Value

JSON Schema for the tool arguments.

async fn call(&self, _args: Self::Args) -> Result<Self::Output, Self::Error>

The tool execution method. Both the arguments and return value are a String since these values are meant to be the output and input of LLM models (respectively)

fn name(&self) -> String

A method returning the name of the tool.

fn call_with_extensions( &self, args: Self::Args, _extensions: &ToolCallExtensions, ) -> impl Future<Output = Result<Self::Output, Self::Error>> + WasmCompatSend

Tool execution with per-call runtime extensions.

fn classify_error(&self, error: &Self::Error) -> ToolFailure

Classify an error returned by this tool into a structured ToolFailure.

fn call_structured( &self, args: Self::Args, extensions: &ToolCallExtensions, ) -> impl Future<Output = Result<ToolReturn<Self::Output>, Self::Error>> + WasmCompatSend

Execute the tool, returning a structured ToolReturn instead of a bare output.