Struct MarkupContent 

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

The type of the Markup

value: String

The content itself

Implementations

impl MarkupContent

pub const fn new(kind: MarkupKind, value: String) -> Self

Trait Implementations

impl Clone for MarkupContent

fn clone(&self) -> MarkupContent

Returns a duplicate 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 From<MarkupContent> for Contents

fn from(v: MarkupContent) -> Self

Converts to this type from the input type.

impl From<MarkupContent> for Documentation

fn from(v: MarkupContent) -> Self

Converts to this type from the input type.

impl From<MarkupContent> for Message

fn from(v: MarkupContent) -> Self

Converts to this type from the input type.

impl From<MarkupContent> for Tooltip

fn from(v: MarkupContent) -> Self

Converts to this type from the input type.

impl Hash for MarkupContent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MarkupContent

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

Tests for self and other values to be equal, and is used by ==.

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

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 StructuralPartialEq for MarkupContent