Struct ResponseError 

pub struct ResponseError {
    pub code: i32,
    pub message: String,
    pub data: Option<Value>,
}

An error response in JSON-RPC format.

Contains a numeric error code, a human-readable message, and optional additional data. The code field is stored as i32 rather than ErrorCode to support unknown error codes from clients or other servers.

Examples

use lsp_server_tokio::{ResponseError, ErrorCode};

// Create a simple error
let error = ResponseError::new(ErrorCode::MethodNotFound, "Method not found");

// Create an error with additional data
let error_with_data = ResponseError::new(ErrorCode::InvalidParams, "Missing required field")
    .with_data(serde_json::json!({"field": "uri"}));

Fields

code: i32

A number indicating the error type.

message: String

A string providing a short description of the error.

data: Option<Value>

A primitive or structured value with additional information. This may be omitted.

Implementations

impl ResponseError

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

Creates a new ResponseError with the given error code and message.

The data field is set to None.

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

Creates a new ResponseError from a raw error code and message.

Use this when dealing with unknown or custom error codes.

pub fn with_data(self, data: Value) -> Self

Adds additional data to this error.

Consumes self and returns a new ResponseError with the data attached.

pub fn error_code(&self) -> Option<ErrorCode>

Returns the error code as an ErrorCode enum, if it maps to a known code.

Trait Implementations

impl Clone for ResponseError

fn clone(&self) -> ResponseError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ResponseError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.