Enum ToolError 

#[non_exhaustive]
pub enum ToolError {
    Message {
        message: String,
        cause: Option<Box<dyn Error + Send + Sync>>,
    },
    Json {
        value: JsonValue,
    },
    Timeout(Duration),
    Cancelled,
}

Error returned by a tool execution.

Tool errors are not fatal: the core turns them into error-text / error-json tool results that are fed back to the model. Only ToolError::Cancelled aborts the whole call.

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.

Message

A textual error.

Fields

message: String

Explanation shown to the model.

cause: Option<Box<dyn Error + Send + Sync>>

Underlying error.

Json

A structured error payload.

Fields

value: JsonValue

The payload.

Timeout(Duration)

The execution exceeded its timeout.

Cancelled

The execution was cancelled.

Implementations

impl ToolError

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

A textual error.

pub fn json(value: JsonValue) -> Self

A structured error.

pub fn from_error(error: impl Error + Send + Sync + 'static) -> Self

Wraps any error, using its display text as the message.

pub fn with_cause(self, cause: impl Error + Send + Sync + 'static) -> Self

Attaches a cause to a ToolError::Message; other variants are returned unchanged.

pub fn is_cancelled(&self) -> bool

Returns true for ToolError::Cancelled.

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.

impl From<Error> for ToolError

fn from(error: Error) -> Self

Converts to this type from the input type.