Struct Rendered 

pub struct Rendered {
    pub html: String,
    pub toc: Option<String>,
}

What a render produced.

Fields

html: String

The markup.

toc: Option<String>

The outline, as markup, or None when the document has no sections.

This is handed over whether or not the document asked for an outline, because where one goes is not always the document’s decision: a host laying out its own page may want the outline beside the article rather than in it, which is a placement no attribute can describe.

It is the same markup html carries when the document does ask for one — so a host that places this itself should unset toc, or the reader gets two. Unsetting it is the whole of what such a host has to do: the outline is still built, and still honours toclevels and toc-title.

Trait Implementations

impl Clone for Rendered

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Rendered

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.