Struct ToolError 

pub struct ToolError {
    pub code: ErrorCode,
    pub message: String,
    pub details: Option<HashMap<String, Value>>,
}

The primary error type that all tool functions must return in their Result.

Fields

code: ErrorCode

A machine-readable code for the error category.

message: String

A human-readable, context-specific error message.

details: Option<HashMap<String, Value>>

Additional error context as key-value pairs.

Implementations

impl ToolError

pub fn new(code: ErrorCode, message: impl Into<String>) -> Self

Create a new ToolError with the given code and message.

pub fn with_details(self, details: HashMap<String, Value>) -> Self

Add details to this error.

pub fn with_detail(self, key: &str, value: impl Into<Value>) -> Self

Add a single detail string to this error.

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

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

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

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

Trait Implementations

impl Debug for ToolError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ToolError

fn fmt(&self, f: &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<&str> for ToolError

fn from(err: &str) -> Self

Converts to this type from the input type.

impl From<Error> for ToolError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ToolError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<String> for ToolError

fn from(err: String) -> Self

Converts to this type from the input type.

impl JsonSchema for ToolError

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for ToolError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.