Struct languageserver_types::MarkupContent
[−]
[src]
pub struct MarkupContent { pub kind: MarkupKind, pub value: String, }
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
impl Debug for MarkupContent
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Eq for MarkupContent
[src]
impl PartialEq for MarkupContent
[src]
fn eq(&self, __arg_0: &MarkupContent) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &MarkupContent) -> bool
[src]
This method tests for !=
.