Struct Markdown

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,
}

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

impl<'a> Markdown<'a>

pub fn into_string(self) -> String

fn into_iter(self) -> CodeBlocks<'a, 'a, impl Iterator<Item = Event<'a>>>

pub(crate) fn split_summary_and_content( self, ) -> (Option<String>, Option<String>)

Convert markdown to (summary, remaining) HTML.

• The summary is the first top-level Markdown element (usually a paragraph, but potentially any block).
• The remaining docs contain everything after the summary.

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