Struct struckdown::html::HtmlRenderer

pub struct HtmlRenderer<'data, 'options, F> { /* fields omitted */ }

Object capable of rendering events to HTML.

Implementations

impl<'data, 'options, F: Write> HtmlRenderer<'data, 'options, F>

pub fn new(
    out: F,
    options: &'options HtmlRendererOptions
) -> HtmlRenderer<'data, 'options, F>

Creates a new renderer that writes into a writer.

pub fn into_writer(self) -> F

Consumes the writer and returns the inner file.

pub fn feed_event(&mut self, event: &AnnotatedEvent<'data>) -> Result<(), Error>

Feeds a single event into the renderer.

pub fn feed_stream<I>(&mut self, iter: I) -> Result<(), Error> where
    I: Iterator<Item = AnnotatedEvent<'data>>, 

Feeds an event stream into the renderer.

In this case the iterator is consumed. Alternatively you can/have to use feed_event directly which lets you pass events by reference instead.

impl<'data, 'options> HtmlRenderer<'data, 'options, Vec<u8>>

pub fn new_buffered(options: &'options HtmlRendererOptions) -> Self

Creates a new html renderer writing into a buffer.

pub fn into_string(self) -> String

Converts the renderer into a string.