#[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
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 Error for Error
impl Error for Error
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()
Source§impl From<Error> for Error
impl From<Error> for Error
Source§fn from(error: Error) -> Self
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
impl From<Error> for ResponseError
Source§fn from(error: Error) -> Self
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.