qlue-ls 2.8.0

A language server for SPARQL
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

use serde::Serialize;

use crate::server::lsp::{
    LspMessage,
    rpc::NotificationMessageBase,
    workdoneprogress::{
        ProgressToken, ProgressValue, WorkDoneProgressBegin, WorkDoneProgressEnd,
        WorkDoneProgressReport,
    },
};

#[derive(Debug, Serialize)]
pub struct ProgressNotification {
    #[serde(flatten)]
    pub base: NotificationMessageBase,
    pub params: ProgressParams<ProgressValue>,
}

impl LspMessage for ProgressNotification {}

impl ProgressNotification {
    pub fn begin_notification(
        token: ProgressToken,
        title: &str,
        cancellable: Option<bool>,
        message: Option<&str>,
        percentage: Option<u32>,
    ) -> Self {
        ProgressNotification {
            base: NotificationMessageBase::new("$/progress"),
            params: ProgressParams {
                token,
                value: ProgressValue::Begin(WorkDoneProgressBegin::new(
                    title,
                    cancellable,
                    message,
                    percentage,
                )),
            },
        }
    }

    pub(crate) fn report_notification(
        token: ProgressToken,
        cancellable: Option<bool>,
        message: Option<&str>,
        percentage: Option<u32>,
    ) -> Self {
        ProgressNotification {
            base: NotificationMessageBase::new("$/progress"),
            params: ProgressParams {
                token,
                value: ProgressValue::Report(WorkDoneProgressReport::new(
                    cancellable,
                    message,
                    percentage,
                )),
            },
        }
    }

    pub(crate) fn end_notification(token: ProgressToken, message: Option<&str>) -> Self {
        ProgressNotification {
            base: NotificationMessageBase::new("$/progress"),
            params: ProgressParams {
                token,
                value: ProgressValue::End(WorkDoneProgressEnd::new(message)),
            },
        }
    }
}

#[derive(Debug, Serialize)]
pub struct ProgressParams<T> {
    token: ProgressToken,
    value: T,
}

#[cfg(test)]
mod tests {
    use crate::server::lsp::{
        ProgressNotification, ProgressParams,
        rpc::NotificationMessageBase,
        workdoneprogress::{
            ProgressValue, WorkDoneProgressBegin, WorkDoneProgressEnd, WorkDoneProgressReport,
        },
    };

    use super::ProgressToken;

    #[test]
    fn serialize() {
        let progress_begin = ProgressNotification {
            base: NotificationMessageBase::new("$/progress"),
            params: ProgressParams {
                token: ProgressToken::Integer(1),
                value: ProgressValue::Begin(WorkDoneProgressBegin::new(
                    "progress title",
                    Some(false),
                    Some("progress message"),
                    Some(0),
                )),
            },
        };
        assert_eq!(
            serde_json::to_string(&progress_begin).unwrap(),
            r#"{"jsonrpc":"2.0","method":"$/progress","params":{"token":1,"value":{"kind":"begin","title":"progress title","cancellable":false,"message":"progress message","percentage":0}}}"#
        );
        let progress_report = ProgressNotification {
            base: NotificationMessageBase::new("$/progress"),
            params: ProgressParams {
                token: ProgressToken::Text("1337-42".to_string()),
                value: ProgressValue::Report(WorkDoneProgressReport::new(
                    Some(false),
                    Some("progress message"),
                    Some(50),
                )),
            },
        };
        assert_eq!(
            serde_json::to_string(&progress_report).unwrap(),
            r#"{"jsonrpc":"2.0","method":"$/progress","params":{"token":"1337-42","value":{"kind":"report","cancellable":false,"message":"progress message","percentage":50}}}"#
        );
        let progress_end = ProgressNotification {
            base: NotificationMessageBase::new("$/progress"),
            params: ProgressParams {
                token: ProgressToken::Text("1337-42".to_string()),
                value: ProgressValue::End(WorkDoneProgressEnd::new(Some("progress message"))),
            },
        };
        assert_eq!(
            serde_json::to_string(&progress_end).unwrap(),
            r#"{"jsonrpc":"2.0","method":"$/progress","params":{"token":"1337-42","value":{"kind":"end","message":"progress message"}}}"#
        );
    }
}