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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

//! implementation of the `workspace/didChangeWatchedFiles` notification
//! 
//! # Usage
//! The [`Server::on_change_watched_files`] notification signals changes to files or folders watched by the server.
//! The recomended way for servers to collect file changes is this notification, 
//! tough it's not the only way. Servers may use other ways like polling file system for changes.

use serde_repr::Deserialize_repr;
use serde::Deserialize;
use crate::{Server, TypeProvider};
use crate::connection::{Endpoint, Callback};

#[derive(Default, Clone)]
pub(crate) struct DidChangeWatchedFilesOptions;

/// A file event that is sent by the client when a file is created, changed or deleted.
#[derive(Deserialize, Debug)]
pub struct FileEvent {
    /// A file URI.
    pub uri: String,
    /// The file change type as defined in [`FileChangeType`].
    #[serde(rename = "type")]
    pub r#type: FileChangeType
}

/// The file change type attached to every [`FileEvent`].
#[repr(i32)]
#[derive(Deserialize_repr, Debug)]
pub enum FileChangeType {
    /// Denotes the creation of a file.
    Created = 1,
    /// Denotes a change to a file.
    Changed = 2,
    /// Denotes the deletion of a file.
    Deleted = 3
}

#[derive(Deserialize)]
struct DidChangeWatchedFilesParams {
    changes: Vec<FileEvent>
}

impl<T: TypeProvider> Server<T> {
    
    /// Sets the callback that will be called when [watched files are changed](self).
    /// 
    /// # Argument
    /// * `callback` - A callback which is called with the following parameters as soon as watch file changes are received:
    ///     * The server instance receiving the response.
    ///     * A vector of [`FileEvent`]s.

    pub fn on_change_watched_files(&mut self, callback: fn (&mut Server<T>, Vec<FileEvent>)) {
        self.workspace.did_change_watched_files.set_callback(Callback::notification(move |server, params: DidChangeWatchedFilesParams| {
            callback(server, params.changes)
        }))
    }
}

impl DidChangeWatchedFilesOptions {
    pub(super) const METHOD: &'static str = "workspace/didChangeWatchedFiles";

    pub(super) fn endpoint<T: TypeProvider>() -> Endpoint<T, DidChangeWatchedFilesOptions> {
        Endpoint::<T, DidChangeWatchedFilesOptions>::new(
            Callback::notification(|_, _: DidChangeWatchedFilesParams| ())
        )
    }
}