Struct Error 

#[non_exhaustive]
pub struct Error {
    pub code: ErrorCode,
    pub message: String,
    pub data: Option<Value>,
}

JSON-RPC error object.

Represents an error that occurred during method execution, following the JSON-RPC 2.0 error object specification with optional additional data.

See protocol docs: JSON-RPC Error Object

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: ErrorCode

A number indicating the error type that occurred. This must be an integer as defined in the JSON-RPC specification.

message: String

A string providing a short description of the error. The message should be limited to a concise single sentence.

data: Option<Value>

Optional primitive or structured value that contains additional information about the error. This may include debugging information or context-specific details.

Implementations

impl Error

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

Creates a new error with the given code and message.

The code parameter can be an ErrorCode constant or a tuple of (code, message).

pub fn data(self, data: impl IntoOption<Value>) -> Self

Adds additional data to the error.

This method is chainable and allows attaching context-specific information to help with debugging or provide more details about the error.

pub fn parse_error() -> Self

Invalid JSON was received by the server. An error occurred on the server while parsing the JSON text.

pub fn invalid_request() -> Self

The JSON sent is not a valid Request object.

pub fn method_not_found() -> Self

The method does not exist / is not available.

pub fn invalid_params() -> Self

Invalid method parameter(s).

pub fn internal_error() -> Self

Internal JSON-RPC error.

pub fn request_cancelled() -> Self

Available on crate feature unstable_cancel_request only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Request was cancelled.

Execution of the method was aborted either due to a cancellation request from the caller or because of resource constraints or shutdown.

pub fn auth_required() -> Self

Authentication required.

pub fn url_elicitation_required() -> Self

Available on crate feature unstable_elicitation only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

The agent requires user input via a URL-based elicitation before it can proceed.

pub fn resource_not_found(uri: Option<String>) -> Self

A given resource, such as a file, was not found.

pub fn into_internal_error(err: impl Error) -> Self

Converts a standard error into an internal JSON-RPC error.

The error’s string representation is included as additional data.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Error

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

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<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<ErrorCode> for Error

fn from(error_code: ErrorCode) -> Self

Converts to this type from the input type.

impl From<ProtocolConversionError> for Error

Available on crate feature unstable_protocol_v2 only.

Converts a ProtocolConversionError into a v1 Error so callers can use ? to bubble conversion failures through APIs that already speak the v1 error type.

The conversion is mapped onto Error::internal_error because a failed cross-version conversion always indicates a protocol mismatch on this side of the wire rather than a client mistake.

fn from(error: ProtocolConversionError) -> Self

Converts to this type from the input type.

impl IntoV2 for Error

Available on crate feature unstable_protocol_v2 only.

type Output = Error

The corresponding v2 draft type.

fn into_v2(self) -> Result<Self::Output>

Converts this value into the corresponding v2 draft type.

impl JsonSchema for Error

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Error

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Error

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Error