Struct lsp_types::MarkupContent
source · pub struct MarkupContent {
pub kind: MarkupKind,
pub value: String,
}
Expand description
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§
source§impl Clone for MarkupContent
impl Clone for MarkupContent
source§fn clone(&self) -> MarkupContent
fn clone(&self) -> MarkupContent
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for MarkupContent
impl Debug for MarkupContent
source§impl<'de> Deserialize<'de> for MarkupContent
impl<'de> Deserialize<'de> for MarkupContent
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl From<MarkupContent> for InlayHintLabelPartTooltip
impl From<MarkupContent> for InlayHintLabelPartTooltip
source§fn from(from: MarkupContent) -> Self
fn from(from: MarkupContent) -> Self
Converts to this type from the input type.
source§impl From<MarkupContent> for InlayHintTooltip
impl From<MarkupContent> for InlayHintTooltip
source§fn from(from: MarkupContent) -> Self
fn from(from: MarkupContent) -> Self
Converts to this type from the input type.
source§impl PartialEq<MarkupContent> for MarkupContent
impl PartialEq<MarkupContent> for MarkupContent
source§fn eq(&self, other: &MarkupContent) -> bool
fn eq(&self, other: &MarkupContent) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.