Enum ToolError 

#[non_exhaustive]
pub enum ToolError {
    Canceled,
    InvalidArgs(BoxError),
    Execution(BoxError),
}

Tool execution error.

The granularity is intentionally coarse — finer-grained error types are carried by built-in tools themselves in the Execution source. Here we only distinguish the broad categories that the main loop needs to handle differently.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Canceled

Canceled by the caller (triggered via ToolContext::cancel).

InvalidArgs(BoxError)

The tool arguments failed JSON parsing or schema validation. The main loop can send this back to the LLM so the model can fix the parameters and retry.

Execution(BoxError)

Runtime error (I/O failure, non-zero subprocess exit, network error, etc.).

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.