Struct ToolError 

pub struct ToolError {
    pub kind: ToolFailure,
    pub message: String,
}

A tool call that could not run, such as invalid arguments. The runtime turns it into a failed ToolOutput whose content is message.

Fields

kind: ToolFailure

message: String

Implementations

impl ToolError

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

The arguments were refused; the model can correct them.

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

The tool or its agent could not be used.

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

A configured limit stopped the call.

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

The call was cancelled.

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

The call ran and failed.

Trait Implementations

impl Clone for ToolError

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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 Eq for ToolError

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<String> for ToolError

fn from(message: String) -> Self

A ToolFailure::Failed error.

impl From<ToolError> for ToolOutput

fn from(error: ToolError) -> Self

The failed result the model sees for a call that could not run.

impl PartialEq for ToolError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ToolError