use std::{fmt, io};
use jsonx_lib::Kind;
use rpc_io::FrameError;
#[derive(Debug)]
#[non_exhaustive]
pub enum Error {
Io(io::Error),
Disconnected,
Frame(FrameError),
ExitWithoutShutdown,
Closed,
InvalidParams(Kind),
}
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Error::Io(e) => write!(f, "language server I/O failed: {e}"),
Error::Disconnected => f.write_str("the client closed the connection before `exit`"),
Error::Frame(e) => write!(f, "invalid message framing: {e}"),
Error::ExitWithoutShutdown => {
f.write_str("the client sent `exit` without requesting `shutdown` first")
}
Error::Closed => f.write_str("the connection is closed"),
Error::InvalidParams(kind) => {
write!(f, "params must be an array, an object, or null, not {kind}")
}
}
}
}
impl std::error::Error for Error {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match self {
Error::Io(e) => Some(e),
Error::Frame(e) => Some(e),
_ => None,
}
}
}
impl From<io::Error> for Error {
fn from(error: io::Error) -> Self {
Error::Io(error)
}
}
impl From<rpc_io::Error> for Error {
fn from(error: rpc_io::Error) -> Self {
match error {
rpc_io::Error::Io(e) => Error::Io(e),
rpc_io::Error::Frame(e) => Error::Frame(e),
rpc_io::Error::InvalidParams(kind) => Error::InvalidParams(kind),
_ => Error::Closed,
}
}
}
#[cfg(test)]
mod tests {
use std::error::Error as _;
use super::*;
#[test]
fn test_error_display_names_the_problem() {
let cases = [
Error::Io(io::Error::other("pipe")),
Error::Disconnected,
Error::Frame(FrameError::MissingContentLength),
Error::ExitWithoutShutdown,
Error::Closed,
Error::InvalidParams(Kind::Number),
];
for e in cases {
assert!(!e.to_string().is_empty());
}
assert!(
Error::InvalidParams(Kind::Number)
.to_string()
.contains("number")
);
}
#[test]
fn test_error_source_exposes_wrapped_errors() {
assert!(Error::Io(io::Error::other("pipe")).source().is_some());
assert!(Error::Frame(FrameError::InvalidHeader).source().is_some());
assert!(Error::Disconnected.source().is_none());
}
#[test]
fn test_error_from_transport_error() {
assert!(matches!(Error::from(rpc_io::Error::Closed), Error::Closed));
assert!(matches!(
Error::from(rpc_io::Error::AlreadyAnswered),
Error::Closed
));
assert!(matches!(
Error::from(rpc_io::Error::InvalidParams(Kind::Bool)),
Error::InvalidParams(Kind::Bool)
));
assert!(matches!(
Error::from(rpc_io::Error::Frame(FrameError::Truncated)),
Error::Frame(FrameError::Truncated)
));
}
}