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 strlinks: &'a [RenderedLink]A list of link replacements.
ids: &'a mut IdMapThe current list of used header IDs.
error_codes: ErrorCodesWhether to allow the use of explicit error codes in doctest lang strings.
edition: EditionDefault edition to use when parsing doctests (to add a fn main).
playground: &'a Option<Playground>heading_offset: HeadingOffsetOffset at which we render headings.
E.g. if heading_offset: HeadingOffset::H2, then # something renders an <h2>.
Implementations
sourceimpl Markdown<'_>
impl Markdown<'_>
pub fn into_string(self) -> String
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
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
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> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,
impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn 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>,
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<'a, T> Captures<'a> for Twhere
T: ?Sized,
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