sync-lsp 0.1.0

A synchronous LSP library for servers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

#![doc = include_str!("../README.md")]

pub use connection::{Transport, Connection, Server, ErrorCode};
pub use sync_lsp_derive::type_provider;
use serde::de::DeserializeOwned;
use serde::Serialize;
use workspace::execute_command::Command;
use std::fmt::Debug;

mod connection;
mod lifecycle;
pub mod text_document;
pub mod window;
pub mod workspace;

/// This trait is used to set type definitions for requests and notifications
/// with dynamic parameters.
/// 
/// For simplicity, it is recommended to use the
/// [`type_provider`] macro instead of implementing the default values manually.
/// Even tough technically allowed by the spec, it is not recommended to use
/// `()` as default types as some lsp clients may return undefined instead of null
/// in their responses causing the a deserialisation error on the server.
pub trait TypeProvider: 'static {
    type Command: Command;
    type CodeLensData: Serialize + DeserializeOwned;
    type CompletionData: Serialize + DeserializeOwned + Debug;
    type Configuration: DeserializeOwned;
    type InitializeOptions: DeserializeOwned;
    type ShowMessageRequestData: Serialize + DeserializeOwned + Default;
    type ApplyEditData: Serialize + DeserializeOwned + Default;
}

//TODO
//Implement dynamic registration support