pub struct Markdown<'a> {
pub content: &'a str,
pub links: &'a [RenderedLink],
pub ids: &'a mut IdMap,
pub error_codes: ErrorCodes,
pub edition: Edition,
pub playground: &'a Option<Playground>,
pub heading_offset: HeadingOffset,
}
Expand description
When to_string
is called, this struct will emit the HTML corresponding to
the rendered version of the contained markdown string.
Fields§
§content: &'a str
§links: &'a [RenderedLink]
A list of link replacements.
ids: &'a mut IdMap
The current list of used header IDs.
error_codes: ErrorCodes
Whether to allow the use of explicit error codes in doctest lang strings.
edition: Edition
Default edition to use when parsing doctests (to add a fn main
).
playground: &'a Option<Playground>
§heading_offset: HeadingOffset
Offset at which we render headings.
E.g. if heading_offset: HeadingOffset::H2
, then # something
renders an <h2>
.
Implementations§
Auto Trait Implementations§
impl<'a> Freeze for Markdown<'a>
impl<'a> RefUnwindSafe for Markdown<'a>
impl<'a> Send for Markdown<'a>
impl<'a> Sync for Markdown<'a>
impl<'a> Unpin for Markdown<'a>
impl<'a> !UnwindSafe for Markdown<'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 moresource§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...)
attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 56 bytes