Enum ToolError 

pub enum ToolError {
    InvalidInput {
        tool: String,
        source: Error,
    },
    Handler {
        tool: String,
        source: HandlerError,
    },
    MissingIdempotencyKey {
        tool: String,
        path: String,
        detail: String,
    },
    MalformedResult {
        tool: String,
        detail: String,
    },
    OutputSerialization {
        tool: String,
        source: Error,
    },
}

The error the type-erased dispatch layer (DynTool::call_json) returns.

The variants are deliberately distinct so the runtime loop can route on them:

• ToolError::InvalidInput means the JSON the model produced did not deserialize into the tool’s Input type. The handler was not called. The loop feeds this back to the model to let it fix its arguments.
• ToolError::Handler means the handler ran and returned a HandlerError. This is a real execution failure, subject to the effect’s retry policy.
• ToolError::MalformedResult means the tool ran and returned something this layer could not read as a result. Like OutputSerialization it is the tool author’s own bug, so it is not retryable: the same bytes decode the same way on a second attempt, and the only thing a retry buys is a slower answer to a question already settled.
• ToolError::OutputSerialization means the handler succeeded but its Output value could not be serialized to JSON. This is an internal fault in the tool definition, not the model’s doing and not a retryable failure.
• ToolError::MissingIdempotencyKey means the operator declared which input field identifies this tool’s calls and the call does not carry it. The tool was not called, and it will not be called unkeyed. Like InvalidInput this is the arguments being wrong, so the loop feeds it back to the model rather than retrying it.

Variants

InvalidInput

The model’s JSON input did not match the tool’s input schema. The handler was never invoked.

Fields

tool: String

The tool that rejected the input.

source: Error

The deserialization error describing why the input was rejected.

Handler

The handler ran and returned a failure.

Fields

tool: String

The tool that failed.

source: HandlerError

The handler’s own error.

MissingIdempotencyKey

The tool has a declared idempotency key path and this call’s input does not yield a key from it. Nothing ran.

See IdempotencyPath::derive for what counts as a key and why falling back to an unkeyed call is not an option here.

Fields

tool: String

The tool whose call was refused.

path: String

The declared path, as the operator wrote it.

detail: String

What went wrong at that path, including the keys the input carries.

MalformedResult

The tool ran and handed back a result the dispatch layer could not read.

Distinct from Handler, which is the tool saying its own work failed. Here the work may well have succeeded; what arrived with it is unreadable, which is a mistake in the tool rather than in the world it talked to. That is the whole reason for the separate variant: a handler failure is worth another attempt under the right effect, and an unreadable result never is.

Fields

tool: String

The tool whose result could not be read.

detail: String

What was wrong with it, in the words of whatever tried to read it.

OutputSerialization

The handler succeeded but its output could not be serialized to JSON.

Fields

tool: String

The tool whose output failed to serialize.

source: Error

The serialization error.

Trait Implementations

impl Debug for ToolError

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

Formats the value using the given formatter.

impl Display for ToolError

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

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.