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: MarkupKindThe type of the Markup
value: StringThe content itself
Trait Implementations§
Source§impl Clone for MarkupContent
impl Clone for MarkupContent
Source§fn clone(&self) -> MarkupContent
fn clone(&self) -> MarkupContent
Returns a duplicate 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 Default for MarkupContent
impl Default for MarkupContent
Source§fn default() -> MarkupContent
fn default() -> MarkupContent
Returns the “default value” for a type. Read more
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
Auto Trait Implementations§
impl Freeze for MarkupContent
impl RefUnwindSafe for MarkupContent
impl Send for MarkupContent
impl Sync for MarkupContent
impl Unpin for MarkupContent
impl UnwindSafe for MarkupContent
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more