Struct Renderer

pub struct Renderer<D: TextDecorator + Clone, C: Converter<D::Annotation>> { /* private fields */ }

A renderer for HTML documents.

This renderer uses html2text to parse and render an HTML document. The provided document is only parsed once: when the instance is constructed. Then it is rendered every time the width of the view changes.

You can custommize the renderer by settting a custom TextDecorator and Converter. The TextDecorator is used by html2text to convert the HTML DOM into annotated strings. The Converter is used by the renderer to interpret the annotations and to extract the text format and links.

Per default, the renderer uses the RichDecorator and the RichConverter.

Implementations

impl Renderer<RichDecorator, RichConverter>

pub fn new(html: &str) -> Renderer<RichDecorator, RichConverter>

Creates a new renderer for the given HTML document using the default settings.

impl<D: TextDecorator + Clone, C: Converter<D::Annotation>> Renderer<D, C>

pub fn custom(html: &str, decorator: D, converter: C) -> Renderer<D, C>

Creates a new renderer for the given HTML document using a custom decorator and converter.

Trait Implementations

impl<D: TextDecorator + Clone, C: Converter<D::Annotation>> Renderer for Renderer<D, C>

fn render(&self, constraint: XY<usize>) -> RenderedDocument

Renders this document within the given size constraint and returns the result.