Struct bsp_types::ShowMessage

pub struct ShowMessage {
    pub typ: MessageType,
    pub message: String,
    pub task: Option<TaskId>,
    pub origin_id: Option<String>,
}

The show message notification is sent from a server to a client to ask the client to display a particular message in the user interface.

A build/showMessage notification is similar to LSP’s window/showMessage, 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.

Fields

typ: MessageType

The message type. See {@link MessageType}.

message: String

The actual message.

task: Option<TaskId>

The task id if any.

origin_id: Option<String>

The request id that originated this notification.

Implementations

impl ShowMessage

pub fn new<S: Into<String>>(
    typ: MessageType,
    msg: S,
    task: Option<TaskId>,
    orid: Option<S>
) -> Self

pub fn info<S: Into<String>>(
    msg: S,
    task: Option<TaskId>,
    orid: Option<S>
) -> Self

Send info message.

pub fn log<S: Into<String>>(
    msg: S,
    task: Option<TaskId>,
    orid: Option<S>
) -> Self

Send log message.

pub fn warn<S: Into<String>>(
    msg: S,
    task: Option<TaskId>,
    orid: Option<S>
) -> Self

Send warn message.

pub fn error<S: Into<String>>(
    msg: S,
    task: Option<TaskId>,
    orid: Option<S>
) -> Self

Send error message.

Trait Implementations

impl Clone for ShowMessage

fn clone(&self) -> ShowMessage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ShowMessage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ShowMessage

fn default() -> ShowMessage

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShowMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for ShowMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.