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

use super::{MessageType, TaskId};
use serde::{Deserialize, Serialize};

/// The log message notification is sent from the server to the client to ask the client to log a
/// particular message.
///
/// A build/logMessage notification is similar to LSP's window/logMessage, except for a few
/// additions like id and originId.
///
/// The originId field helps clients know which request originated a notification in case several
/// requests are handled by the client at the same time. It will only be populated if the client
/// defined it in the request that triggered this notification.
#[derive(Default, Debug, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct LogMessage {
    /// The message type. See {@link MessageType}.
    #[serde(rename = "type")]
    pub typ: MessageType,

    /// The task id if any.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub task: Option<TaskId>,

    /// The request id that originated this notification.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub origin_id: Option<String>,

    /// The actual message.
    pub message: String,
}

impl LogMessage {
    pub fn new<S: Into<String>>(
        typ: MessageType,
        msg: S,
        task: Option<TaskId>,
        orid: Option<S>,
    ) -> Self {
        Self {
            typ,
            task: task.map(Into::into),
            origin_id: orid.map(Into::into),
            message: msg.into(),
        }
    }

    /// Send info message.
    pub fn info<S: Into<String>>(msg: S, task: Option<TaskId>, orid: Option<S>) -> Self {
        Self::new(MessageType::Info, msg, task, orid)
    }

    /// Send log message.
    pub fn log<S: Into<String>>(msg: String, task: Option<TaskId>, orid: Option<String>) -> Self {
        Self::new(MessageType::Log, msg, task, orid)
    }

    /// Send warn message.
    pub fn warn<S: Into<String>>(msg: S, task: Option<TaskId>, orid: Option<S>) -> Self {
        Self::new(MessageType::Warning, msg, task, orid)
    }

    /// Send error message.
    pub fn error<S: Into<String>>(msg: S, task: Option<TaskId>, orid: Option<S>) -> Self {
        Self::new(MessageType::Error, msg, task, orid)
    }
}