pub struct MarkdownEscaped<'a>(pub &'a str);Expand description
Escapes markdown special characters in markdown text blocks. Markdown code blocks follow
different rules and MarkdownInlineCode or MarkdownCodeBlock should be used in that case.
Also escapes the following markdown extensions:
^for superscripts$for inline math~for strikethrough
Escape of some characters is unnecessary, because while they are involved in markdown syntax, the other characters involved are escaped:
-
!,],(, and)are used in link syntax, but[is escaped so these are parsed as plaintext. -
;is used in HTML entity syntax, but&is escaped, so they are parsed as plaintext.
TODO: There is one escape this doesn’t do currently. Period after numbers at the start of the
line ([0-9]*\.) should also be escaped to avoid it being interpreted as a list item.
Tuple Fields§
§0: &'a strTrait Implementations§
Auto Trait Implementations§
impl<'a> Freeze for MarkdownEscaped<'a>
impl<'a> RefUnwindSafe for MarkdownEscaped<'a>
impl<'a> Send for MarkdownEscaped<'a>
impl<'a> Sync for MarkdownEscaped<'a>
impl<'a> Unpin for MarkdownEscaped<'a>
impl<'a> UnwindSafe for MarkdownEscaped<'a>
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
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more