Struct lsp_types::MarkupContent
source · [−]pub struct MarkupContent {
pub kind: MarkupKind,
pub value: String,
}
Expand description
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:
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
sourceimpl Clone for MarkupContent
impl Clone for MarkupContent
sourcefn clone(&self) -> MarkupContent
fn clone(&self) -> MarkupContent
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for MarkupContent
impl Debug for MarkupContent
sourceimpl<'de> Deserialize<'de> for MarkupContent
impl<'de> Deserialize<'de> for MarkupContent
sourcefn 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
sourceimpl PartialEq<MarkupContent> for MarkupContent
impl PartialEq<MarkupContent> for MarkupContent
sourcefn eq(&self, other: &MarkupContent) -> bool
fn eq(&self, other: &MarkupContent) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &MarkupContent) -> bool
fn ne(&self, other: &MarkupContent) -> bool
This method tests for !=
.
sourceimpl Serialize for MarkupContent
impl Serialize for MarkupContent
impl Eq for MarkupContent
impl StructuralEq for MarkupContent
impl StructuralPartialEq for MarkupContent
Auto Trait Implementations
impl RefUnwindSafe for MarkupContent
impl Send for MarkupContent
impl Sync for MarkupContent
impl Unpin for MarkupContent
impl UnwindSafe for MarkupContent
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more