Enum ToolError 

pub enum ToolError {
    NotFound {
        name: String,
    },
    Unavailable {
        name: String,
        reason: ToolUnavailableReason,
    },
    InvalidArguments {
        name: String,
        reason: String,
    },
    ExecutionFailed {
        message: String,
    },
    ExecutionFailedWithData {
        message: String,
        data: Value,
    },
    Timeout {
        name: String,
        timeout_ms: u64,
    },
    AccessDenied {
        name: String,
    },
    Other(String),
    CallbackPending {
        tool_name: String,
        args: Value,
    },
}

Error returned by tool dispatch operations.

Variants

NotFound

The requested tool was not found

Fields

name: String

Unavailable

The tool exists but is currently unavailable

Fields

name: String

reason: ToolUnavailableReason

InvalidArguments

The tool arguments failed validation

Fields

name: String

reason: String

ExecutionFailed

The tool execution failed

Fields

message: String

ExecutionFailedWithData

The tool execution failed with structured error data for protocol surfaces.

Fields

message: String

data: Value

Timeout

The tool execution timed out

Fields

name: String

timeout_ms: u64

AccessDenied

Tool access was denied by policy

Fields

name: String

Other(String)

A generic tool error with a message

CallbackPending

Tool call must be routed externally (callback pending)

This variant signals that a tool call cannot be handled internally and must be routed to an external handler. The payload contains serialized information about the pending tool call.

Fields

tool_name: String

args: Value

Implementations

impl ToolError

pub fn error_code(&self) -> &'static str

pub fn to_error_payload(&self) -> Value

pub fn to_transcript_content(&self) -> String

Render the canonical model-facing transcript text for this typed error.

This is the single render boundary over the typed error: it projects Self::to_error_payload into the JSON string that appears in the conversation transcript. It is infallible — serde_json::Value always renders via its Display impl — so there is no fallback string that could mask a serialization fault.

pub fn not_found(name: impl Into<String>) -> ToolError

pub fn unavailable( name: impl Into<String>, reason: ToolUnavailableReason, ) -> ToolError

pub fn invalid_arguments( name: impl Into<String>, reason: impl Into<String>, ) -> ToolError

pub fn execution_failed(message: impl Into<String>) -> ToolError

pub fn execution_failed_with_data( message: impl Into<String>, data: Value, ) -> ToolError

pub fn structured_data(&self) -> Option<Value>

pub fn timeout(name: impl Into<String>, timeout_ms: u64) -> ToolError

pub fn access_denied(name: impl Into<String>) -> ToolError

pub fn other(message: impl Into<String>) -> ToolError

pub fn callback_pending(tool_name: impl Into<String>, args: Value) -> ToolError

Create a callback pending error for external tool routing

pub fn is_callback_pending(&self) -> bool

Check if this is a callback pending error

pub fn as_callback_pending(&self) -> Option<(&str, &Value)>

Extract callback pending info if this is a CallbackPending error

Trait Implementations

impl Clone for ToolError

fn clone(&self) -> ToolError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolError

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for ToolError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Error for ToolError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<&str> for ToolError

fn from(s: &str) -> ToolError

Converts to this type from the input type.

impl From<String> for ToolError

fn from(s: String) -> ToolError

Converts to this type from the input type.

impl From<ToolError> for DispatchError

fn from(source: ToolError) -> Self

Converts to this type from the input type.

impl PartialEq for ToolError

fn eq(&self, other: &ToolError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ToolError