Struct Html

pub struct Html { /* private fields */ }

HTML renderer

This can be used to render markdown documents to HTML. This type can also be leveraged to create custom renderers that delegate to the HTML renderer in certain cases, as shown in the Render trait documentation example.

let input = Buffer::from("EMPHASIZE");
let mut output = Buffer::new(64usize);
let mut html_renderer = Html::new(Flags::empty(), 0);

html_renderer.emphasis(&mut output, Some(&input));

assert_eq!(output.to_str().unwrap(), "<em>EMPHASIZE</em>");

Implementations

impl Html

pub fn new(flags: Flags, nesting_level: i32) -> Html

Construct a new html renderer given the provided html flags and table of contents nesting level.

The toc method can be used to construct a table of contents renderer which renders only the table of contents. The nesting_level on this method determines the maximum depth of headers to associate with the table of contents.

For this reason, if a table of contents is going to be rendered, this method’s nesting_level argument should be the same as the one passed to the toc method.

pub fn toc(nesting_level: i32) -> Html

Construct a table of contents renderer.

This renderer will only render the table of contents. If you want to have the headers of the document specify id attributes so that the table of contents items link to the correct header, you should render the document with the renderer returned by the new method with the same value for the nesting_level parameter.

pub fn get(&self) -> &hoedown_renderer

Get a reference to the underlying hoedown renderer

pub fn as_mut(&mut self) -> &mut hoedown_renderer

Get a mutable reference to the underlying hoedown renderer

Trait Implementations

impl Drop for Html

fn drop(&mut self)

Executes the destructor for this type.

impl Render for Html

unsafe fn to_hoedown(&mut self) -> hoedown_renderer

Converts the type into an underlying hoedown_renderer structure.

fn code_block( &mut self, ob: &mut Buffer, text: Option<&Buffer>, lang: Option<&Buffer>, )

Runs when a codeblock is encountered

fn quote_block(&mut self, ob: &mut Buffer, content: Option<&Buffer>)

Runs when a block quote is encountered

fn header(&mut self, ob: &mut Buffer, content: Option<&Buffer>, level: i32)

Runs when a header is encountered

fn horizontal_rule(&mut self, ob: &mut Buffer)

Runs when a horizontal rule is encountered

fn list(&mut self, ob: &mut Buffer, content: Option<&Buffer>, flags: List)

Runs when a list is encountered.

fn list_item(&mut self, ob: &mut Buffer, content: Option<&Buffer>, flags: List)

Runs when a list item is encountered.

fn paragraph(&mut self, ob: &mut Buffer, content: Option<&Buffer>)

Runs when a paragraph is encountered.

fn table(&mut self, ob: &mut Buffer, content: Option<&Buffer>)

Runs when a table is encountered.

fn table_header(&mut self, ob: &mut Buffer, content: Option<&Buffer>)

Runs when a table header is encountered.

fn table_body(&mut self, ob: &mut Buffer, content: Option<&Buffer>)

Runs when a table body is encountered.

fn table_row(&mut self, ob: &mut Buffer, content: Option<&Buffer>)

Runs when a table row is encountered.

fn table_cell( &mut self, ob: &mut Buffer, content: Option<&Buffer>, flags: Table, )

Runs when a table cell is encountered.

fn footnotes(&mut self, ob: &mut Buffer, content: Option<&Buffer>)

Runs when footnotes are encountered.

fn footnote_definition( &mut self, ob: &mut Buffer, content: Option<&Buffer>, num: u32, )

Runs when a footnote definition is encountered.

fn html_block(&mut self, ob: &mut Buffer, text: Option<&Buffer>)

Runs when a raw html block is encountered.

fn autolink( &mut self, ob: &mut Buffer, link: Option<&Buffer>, ty: AutoLink, ) -> bool

Runs when an autolink candidate is encountered.

fn code_span(&mut self, ob: &mut Buffer, text: Option<&Buffer>) -> bool

Runs when a code span is encountered.

fn double_emphasis(&mut self, ob: &mut Buffer, content: Option<&Buffer>) -> bool

Runs when double emphasis is encountered.

fn emphasis(&mut self, ob: &mut Buffer, content: Option<&Buffer>) -> bool

Runs when emphasis is encountered.

fn underline(&mut self, ob: &mut Buffer, content: Option<&Buffer>) -> bool

Runs when underline is encountered.

fn highlight(&mut self, ob: &mut Buffer, content: Option<&Buffer>) -> bool

Runs when highlight is encountered.

fn quote_span(&mut self, ob: &mut Buffer, content: Option<&Buffer>) -> bool

Runs when a quote is encountered.

fn image( &mut self, ob: &mut Buffer, link: Option<&Buffer>, title: Option<&Buffer>, alt: Option<&Buffer>, ) -> bool

Runs when an image is encountered.

fn line_break(&mut self, ob: &mut Buffer) -> bool

Runs when a line break is encountered.

fn link( &mut self, ob: &mut Buffer, content: Option<&Buffer>, link: Option<&Buffer>, title: Option<&Buffer>, ) -> bool

Runs when a link is encountered.

fn triple_emphasis(&mut self, ob: &mut Buffer, content: Option<&Buffer>) -> bool

Runs when triple emphasis is encountered.

fn strikethrough(&mut self, ob: &mut Buffer, content: Option<&Buffer>) -> bool

Runs when strikethrough is encountered.

fn superscript(&mut self, ob: &mut Buffer, content: Option<&Buffer>) -> bool

Runs when superscript is encountered.

fn footnote_reference(&mut self, ob: &mut Buffer, num: u32) -> bool

Runs when a footnote reference is encountered.

fn math( &mut self, ob: &mut Buffer, text: Option<&Buffer>, displaymode: i32, ) -> bool

Runs when math is encountered.

fn html_span(&mut self, ob: &mut Buffer, text: Option<&Buffer>) -> bool

Runs when raw html span is encountered.

fn entity(&mut self, ob: &mut Buffer, text: Option<&Buffer>)

Runs when an html entity is encountered.

fn normal_text(&mut self, ob: &mut Buffer, text: Option<&Buffer>)

Runs when plain text is encountered.

fn before_render(&mut self, ob: &mut Buffer, inline_render: bool)

Runs before the document is processed.

fn after_render(&mut self, ob: &mut Buffer, inline_render: bool)

Runs after the document has been processed.

fn render(&mut self, input: &Markdown) -> Buffer

Render the document to a buffer that is returned

fn render_to(&mut self, input: &Markdown, output: &mut Buffer)

Render the document into the given buffer

fn render_inline(&mut self, input: &Markdown) -> Buffer

Render the document as inline to a buffer that is returned

fn render_inline_to(&mut self, input: &Markdown, output: &mut Buffer)

Render the document as inline into the given buffer