Struct lsp_types::MarkupContent

pub struct MarkupContent {
    pub kind: MarkupKind,
    pub value: String,
}

A MarkupContent literal represents a string value which content can be represented in different formats. Currently plaintext and markdown are supported formats. A MarkupContent is usually used in documentation properties of result literals like CompletionItem or SignatureInformation. If the format is markdown the content should follow the GitHub Flavored Markdown Specification.

Here is an example how such a string can be constructed using JavaScript / TypeScript:

let markdown: MarkupContent = {
    kind: MarkupKind::Markdown,
    value: [
        "# Header",
        "Some text",
        "```typescript",
        "someCode();",
        "```"
    ]
    .join("\n"),
};

Please Note* that clients might sanitize the return markdown. A client could decide to remove HTML from the markdown to avoid script execution.

Fields

kind: MarkupKind

value: String

Trait Implementations

impl Clone for MarkupContent

fn clone(&self) -> MarkupContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MarkupContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MarkupContent

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<MarkupContent> for MarkupContent

fn eq(&self, other: &MarkupContent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MarkupContent

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

Serialize this value into the given Serde serializer.

impl Eq for MarkupContent

impl StructuralEq for MarkupContent

impl StructuralPartialEq for MarkupContent