Struct ToolError 

pub struct ToolError {
    pub code: ToolErrorCode,
    pub message: String,
    pub cause: Option<Value>,
    pub meta: Option<Value>,
}

Structured tool error, shape-compatible with the TS ToolError.

meta stores arbitrary JSON payload fields (e.g. {"path": "...", "siblings": [...]}) that callers can inspect without parsing the message text. cause is an opaque JSON blob preserving the underlying error chain when available.

Fields

code: ToolErrorCode

message: String

cause: Option<Value>

meta: Option<Value>

Implementations

impl ToolError

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

pub fn with_meta(self, meta: Value) -> Self

pub fn with_cause(self, cause: Value) -> Self

Trait Implementations

impl Clone for ToolError

fn clone(&self) -> ToolError

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<'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 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.