Enum ToolError 

#[non_exhaustive]
pub enum ToolError {
    UnknownTool(String),
    InvalidArgs(String),
    Retryable {
        message: String,
        retry_after_secs: u32,
    },
    Permanent(String),
    Timeout,
    Cancelled,
}

Tool invocation errors.

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.

UnknownTool(String)

Tool name not registered with the invoker.

InvalidArgs(String)

Arguments did not match the declared JSON-schema.

Retryable

Tool returned a transient failure; runtime may retry.

Fields

message: String

Human-readable reason.

retry_after_secs: u32

Suggested delay before retry.

Permanent(String)

Tool returned a permanent failure.

Timeout

Tool execution exceeded its timeout.

Cancelled

Tool invocation was cooperatively cancelled (e.g. HTTP/SSE client disconnected mid-stream).

Implementations

impl ToolError

pub fn retryable(&self) -> bool

Returns true if the runtime should retry the tool call.

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 Error

fn from(source: ToolError) -> Self

Converts to this type from the input type.