Struct ReadTool 

pub struct ReadTool { /* private fields */ }

The built-in read tool. Holds an Arc<dyn ExecutionEnv> (read-only view) and an optional image processor.

Trait Implementations

impl AgentTool for ReadTool

fn schema(&self) -> &Tool

The provider-facing tool definition (name, description, parameters schema).

fn label(&self) -> &str

Human-readable label for UI display.

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, _tool_call_id: &'life1 str, params: Value, signal: CancellationToken, _on_update: Arc<dyn Fn(ToolResultPartial) + Send + Sync>, ) -> Pin<Box<dyn Future<Output = Result<AgentToolResult, AgentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute the tool call. Throw via Err(AgentError) on failure — the loop encodes the error message into an error ToolResultMessage.

fn execution_mode(&self) -> ToolExecutionMode

Per-tool execution-mode override. Sequential forces one-at-a-time for the whole batch when any tool in it returns Sequential; Parallel (default) allows concurrency.

fn prepare_arguments(&self, args: Value) -> Result<Value, AgentError>

Optional compatibility shim for raw tool-call arguments before schema validation. Default is identity. Mirrors TS prepareArguments.