Enum ToolError 

pub enum ToolError {
    ExecutionFailed {
        message: String,
        retryable: bool,
    },
    NotFound(String),
    ModelRetry(String),
    ApprovalRequired {
        tool_name: String,
        args: Value,
    },
    CallDeferred {
        tool_name: String,
        args: Value,
    },
    Timeout(Duration),
    ValidationFailed {
        tool_name: String,
        errors: Vec<ValidationError>,
    },
    Cancelled,
    ToolReturnedError(String),
    Json(Error),
    Other(Error),
}

Errors that can occur during tool execution.

Variants

ExecutionFailed

Tool execution failed.

Fields

message: String

Error message.

retryable: bool

Whether this error is retryable.

NotFound(String)

Tool not found in registry.

ModelRetry(String)

Model should retry with different arguments.

ApprovalRequired

Tool requires approval before execution.

Fields

tool_name: String

Name of the tool requiring approval.

args: Value

Arguments that were provided.

CallDeferred

Tool call was deferred for later execution.

Fields

tool_name: String

Name of the deferred tool.

args: Value

Arguments for the deferred call.

Timeout(Duration)

Tool execution timed out.

ValidationFailed

Tool argument validation failed.

Fields

tool_name: String

Name of the tool.

errors: Vec<ValidationError>

Validation errors.

Cancelled

Tool was cancelled.

ToolReturnedError(String)

Tool returned an error result.

Json(Error)

JSON serialization/deserialization error.

Other(Error)

Other errors.

Implementations

impl ToolError

pub fn is_retryable(&self) -> bool

Check if this error is retryable.

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

Create a non-retryable execution failure.

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

Create a retryable execution failure.

pub fn validation_failed( tool_name: impl Into<String>, errors: Vec<ValidationError>, ) -> Self

Create a validation failed error with multiple issues.

pub fn validation_error( tool_name: impl Into<String>, field: Option<String>, message: impl Into<String>, ) -> Self

Create a validation failed error with a single issue.

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

Create an invalid arguments error for argument parsing.

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

Create a not found error.

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

Create a model retry error.

pub fn approval_required(tool_name: impl Into<String>, args: Value) -> Self

Create an approval required error.

pub fn call_deferred(tool_name: impl Into<String>, args: Value) -> Self

Create a call deferred error.

pub fn timeout(duration: Duration) -> Self

Create a timeout error.

pub fn message(&self) -> String

Get the error message.

pub fn is_approval_required(&self) -> bool

Check if this is an approval required error.

pub fn is_call_deferred(&self) -> bool

Check if this is a call deferred error.

pub fn is_model_retry(&self) -> bool

Check if this is a model retry 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.

impl From<&ToolError> for ToolErrorInfo

fn from(err: &ToolError) -> Self

Converts to this type from the input type.

impl From<&str> for ToolError

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Error> for ToolError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ToolError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<String> for ToolError

fn from(s: String) -> Self

Converts to this type from the input type.