Skip to main content

ErrorCode

Struct ErrorCode 

Source
pub struct ErrorCode(pub i64);
Expand description

A JSON-RPC error code.

The constants are the five codes JSON-RPC 2.0 defines, plus three the crate itself answers with. Any integer is a valid code; protocols define their own (LSP’s ContentModified is -32801, LexerSketch’s “stale version” is 1001), and a peer’s code is passed through as it was sent.

§Examples

use rpc_io::ErrorCode;

assert_eq!(ErrorCode::METHOD_NOT_FOUND.0, -32601);
assert_eq!(ErrorCode::METHOD_NOT_FOUND.name(), Some("method not found"));
assert_eq!(ErrorCode(1001).name(), None);
assert_eq!(ErrorCode::INVALID_PARAMS.to_string(), "-32602 (invalid params)");

Tuple Fields§

§0: i64

Implementations§

Source§

impl ErrorCode

Source

pub const PARSE_ERROR: ErrorCode

-32700: the message is not valid JSON.

Source

pub const INVALID_REQUEST: ErrorCode

-32600: the message is JSON but not a valid request object.

Source

pub const METHOD_NOT_FOUND: ErrorCode

-32601: no handler is registered for the method.

Source

pub const INVALID_PARAMS: ErrorCode

-32602: the params are not what the method takes.

Source

pub const INTERNAL_ERROR: ErrorCode

-32603: the server failed, for example a handler panicked.

Source

pub const SERVER_OVERLOADED: ErrorCode

-32000: too many requests are already being answered. The first code of the range JSON-RPC 2.0 reserves for implementation-defined server errors.

Source

pub const SERVER_NOT_INITIALIZED: ErrorCode

-32002: a request arrived before the protocol’s opening request succeeded (LSP’s ServerNotInitialized); see Gate.

Source

pub const REQUEST_CANCELLED: ErrorCode

-32800: the request was cancelled by its sender (LSP’s RequestCancelled); see Cancellation.

Source

pub const fn name(self) -> Option<&'static str>

A short name for the codes this crate defines, None for others.

§Examples
assert_eq!(rpc_io::ErrorCode::PARSE_ERROR.name(), Some("parse error"));
Source

pub const fn is_reserved(self) -> bool

Whether the code lies in -32768..=-32000, the range JSON-RPC 2.0 reserves for predefined and implementation-defined errors.

§Examples
use rpc_io::ErrorCode;

assert!(ErrorCode::INTERNAL_ERROR.is_reserved());
assert!(!ErrorCode(1001).is_reserved());

Trait Implementations§

Source§

impl Clone for ErrorCode

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ErrorCode

Source§

impl Debug for ErrorCode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ErrorCode

Source§

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

The number, with the name when the code has one.

Source§

impl Eq for ErrorCode

Source§

impl Hash for ErrorCode

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for ErrorCode

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for ErrorCode

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for ErrorCode

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for ErrorCode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.