Struct languageserver_types::MarkupContent
source · pub struct MarkupContent {
pub kind: MarkupKind,
pub value: String,
}
Expand description
A MarkupContent
literal represents a string value which content is interpreted base on its
kind flag. Currently the protocol supports plaintext
and markdown
as markup kinds.
If the kind is markdown
then the value can contain fenced code blocks like in GitHub issues.
See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
Here is an example how such a string can be constructed using JavaScript / TypeScript:
let markdown: MarkdownContent = {
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