[Language Server Protocol] implementation for Rust based on [Tower].
Tower is a simple and composable framework for implementing asynchronous
services in Rust. Central to Tower is the [Service
] trait, which provides the
necessary abstractions for defining request/response clients and servers.
Examples of protocols implemented using the Service
trait include
[tower-web
] and [tower-grpc
].
This library (tower-lsp
) provides a simple implementation of the Language
Server Protocol (LSP) that makes it easy to write your own language server. It
consists of three parts:
LanguageServer
trait which defines the behavior of your language server.LspService
delegate which wraps your language server
implementation and defines the behavior of the protocol.Server
which spawns the LspService
and processes requests and responses
over stdin and stdout.```rust use futures::future; use jsonrpccore::{BoxFuture, Result}; use serdejson::Value; use towerlsp::lsptypes::request::GotoDefinitionResponse; use towerlsp::lsptypes::*; use tower_lsp::{LanguageServer, LspService, Printer, Server};
struct Backend;
impl LanguageServer for Backend { type ShutdownFuture = BoxFuture<()>; type SymbolFuture = BoxFuture
fn initialize(&self, _: &Printer, _: InitializeParams) -> Result<InitializeResult> {
Ok(InitializeResult::default())
}
fn initialized(&self, printer: &Printer, _: InitializedParams) {
printer.log_message(MessageType::Info, "server initialized!");
}
fn shutdown(&self) -> Self::ShutdownFuture {
Box::new(future::ok(()))
}
fn symbol(&self, _: WorkspaceSymbolParams) -> Self::SymbolFuture {
Box::new(future::ok(None))
}
fn execute_command(&self, _: &Printer, _: ExecuteCommandParams) -> Self::ExecuteFuture {
Box::new(future::ok(None))
}
fn completion(&self, _: CompletionParams) -> Self::CompletionFuture {
Box::new(future::ok(None))
}
fn goto_declaration(&self, _: TextDocumentPositionParams) -> Self::DeclarationFuture {
Box::new(future::ok(None))
}
fn goto_definition(&self, _: TextDocumentPositionParams) -> Self::DefinitionFuture {
Box::new(future::ok(None))
}
fn goto_type_definition(&self, _: TextDocumentPositionParams) -> Self::TypeDefinitionFuture {
Box::new(future::ok(None))
}
fn hover(&self, _: TextDocumentPositionParams) -> Self::HoverFuture {
Box::new(future::ok(None))
}
fn document_highlight(&self, _: TextDocumentPositionParams) -> Self::HighlightFuture {
Box::new(future::ok(None))
}
}
fn main() { let stdin = tokio::io::stdin(); let stdout = tokio::io::stdout();
let (service, messages) = LspService::new(Backend::default());
let handle = service.close_handle();
let server = Server::new(stdin, stdout)
.interleave(messages)
.serve(service);
tokio::run(handle.run_until_exit(server));
} ```
tower-lsp
is free and open source software distributed under the terms of
both the MIT and the Apache 2.0 licenses.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.