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,
pub custom_code_classes_in_docs: bool,
}
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>
.
custom_code_classes_in_docs: bool
true
if the custom_code_classes_in_docs
feature is enabled.
Implementations§
Auto Trait Implementations§
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
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> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,
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