Struct html2text::render::text_renderer::PlainDecorator

pub struct PlainDecorator { /* private fields */ }

A decorator for use with SubRenderer which outputs plain UTF-8 text with no annotations. Markup is rendered as text characters or footnotes.

Implementations

impl PlainDecorator

pub fn new() -> PlainDecorator

Create a new PlainDecorator.

Trait Implementations

impl Clone for PlainDecorator

fn clone(&self) -> PlainDecorator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlainDecorator

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

Formats the value using the given formatter.

impl TextDecorator for PlainDecorator

type Annotation = ()

An annotation which can be added to text, and which will be attached to spans of text.

fn decorate_link_start(&mut self, _url: &str) -> (String, Self::Annotation)

Return an annotation and rendering prefix for a link.

fn decorate_link_end(&mut self) -> String

Return a suffix for after a link.

fn decorate_em_start(&self) -> (String, Self::Annotation)

Return an annotation and rendering prefix for em

fn decorate_em_end(&self) -> String

Return a suffix for after an em.

fn decorate_strong_start(&self) -> (String, Self::Annotation)

Return an annotation and rendering prefix for strong

fn decorate_strong_end(&self) -> String

Return a suffix for after a strong.

fn decorate_strikeout_start(&self) -> (String, Self::Annotation)

Return an annotation and rendering prefix for strikeout

fn decorate_strikeout_end(&self) -> String

Return a suffix for after a strikeout.

fn decorate_code_start(&self) -> (String, Self::Annotation)

Return an annotation and rendering prefix for code

fn decorate_code_end(&self) -> String

Return a suffix for after a code.

fn decorate_preformat_first(&self) -> Self::Annotation

Return an annotation for the initial part of a preformatted line

fn decorate_preformat_cont(&self) -> Self::Annotation

Return an annotation for a continuation line when a preformatted line doesn’t fit.

fn decorate_image( &mut self, _src: &str, title: &str ) -> (String, Self::Annotation)

Return an annotation and rendering prefix for a link.

fn header_prefix(&self, level: usize) -> String

Return prefix string of header in specific level.

fn quote_prefix(&self) -> String

Return prefix string of quoted block.

fn unordered_item_prefix(&self) -> String

Return prefix string of unordered list item.

fn ordered_item_prefix(&self, i: i64) -> String

Return prefix string of ith ordered list item.

fn finalise(&mut self, links: Vec<String>) -> Vec<TaggedLine<()>>

Finish with a document, and return extra lines (eg footnotes) to add to the rendered text.

fn make_subblock_decorator(&self) -> Self

Return a new decorator of the same type which can be used for sub blocks.

fn push_colour(&mut self, _: Colour) -> Option<Self::Annotation>

Return an annotation corresponding to adding colour, or none.

fn pop_colour(&mut self) -> bool

Pop the last colour pushed if we pushed one.

fn push_bgcolour(&mut self, _: Colour) -> Option<Self::Annotation>

Return an annotation corresponding to adding background colour, or none.

fn pop_bgcolour(&mut self) -> bool

Pop the last background colour pushed if we pushed one.

fn decorate_superscript_start(&self) -> (String, Self::Annotation)

Return an annotation and rendering prefix for superscript text

fn decorate_superscript_end(&self) -> String

Return a suffix for after a superscript.