Skip to main content

Error

Enum Error 

Source
#[non_exhaustive]
pub enum Error { Io(Error), Disconnected, Frame(FrameError), ExitWithoutShutdown, Closed, InvalidParams(Kind), }
Expand description

Something went wrong in the server itself, as opposed to a request that failed, which is a ResponseError sent to the client.

Server::run returns one when the session cannot go on: the connection failed or closed, the client’s framing broke, or the client exited without the shutdown handshake. In each case the editor is gone or the stream is unusable, so the right response is to exit the process with a non-zero status, as the protocol asks. Error::Closed and Error::InvalidParams are the exceptions: they come from a handler’s own sends (Context::notify, Context::request) and describe that one send.

Malformed JSON inside a well-framed message is not an Error: the server answers it with a protocol error and carries on, as it does for a message over the size limit.

§Examples

use lsp_lang::Error;

fn exit_code(result: Result<(), Error>) -> i32 {
    match result {
        Ok(()) => 0, // `shutdown` then `exit`: a clean stop.
        Err(Error::ExitWithoutShutdown) => 1,
        Err(_) => 1,
    }
}
assert_eq!(exit_code(Err(Error::Disconnected)), 1);

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Io(Error)

Reading from or writing to the client failed.

The connection is broken; exit. The wrapped error is the transport’s.

§

Disconnected

The client’s input ended before it sent exit, typically because the editor closed or crashed, or ended partway through a message.

§

Frame(FrameError)

The input lost its base-protocol framing, so the stream cannot be split into messages any more: no Content-Length, a malformed length, an over-long or malformed header. A message that is merely over the size limit is not this error; it is skipped and refused, and the session goes on (see Server::with_message_limit).

§

ExitWithoutShutdown

The client sent exit without a shutdown request first. The protocol asks the server to exit with status 1 in this case.

§

Closed

The connection is closed, so nothing more can be sent: the session has ended, or writing to the client failed earlier.

§

InvalidParams(Kind)

A notification’s or request’s params was not an array, an object, or null. Nothing was sent. Inside a request handler, ? turns it into an INTERNAL_ERROR response.

Trait Implementations§

Source§

impl Debug for Error

Source§

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

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

impl Display for Error

Source§

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

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

impl Error for Error

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<Error> for Error

Source§

fn from(error: Error) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for Error

Source§

fn from(error: Error) -> Self

Maps the transport’s error: framing and I/O failures keep their meaning, bad outgoing params stay bad params, and anything else about a closed or already-answered connection is Error::Closed.

Source§

impl From<Error> for ResponseError

Source§

fn from(error: Error) -> Self

Turns a library error met while serving a request, in practice a send that failed, into an INTERNAL_ERROR response.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Error

§

impl !UnwindSafe for Error

§

impl Forget for Error

§

impl Freeze for Error

§

impl Move for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

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