[−][src]Struct lsp_types::MarkupContent
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:
ⓘThis example is not tested
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
impl Clone for MarkupContent
[src]
pub fn clone(&self) -> MarkupContent
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for MarkupContent
[src]
impl<'de> Deserialize<'de> for MarkupContent
[src]
pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Eq for MarkupContent
[src]
impl PartialEq<MarkupContent> for MarkupContent
[src]
pub fn eq(&self, other: &MarkupContent) -> bool
[src]
pub fn ne(&self, other: &MarkupContent) -> bool
[src]
impl Serialize for MarkupContent
[src]
pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralEq for MarkupContent
[src]
impl StructuralPartialEq for MarkupContent
[src]
Auto Trait Implementations
impl RefUnwindSafe for MarkupContent
[src]
impl Send for MarkupContent
[src]
impl Sync for MarkupContent
[src]
impl Unpin for MarkupContent
[src]
impl UnwindSafe for MarkupContent
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,