Struct Html5Document 

pub struct Html5Document {
    pub(super) base: HtmlBase,
}

HTML document backed by the html5ever spec-compliant parser.

Handles HTML entities, void elements (<br>, <img>), and implicitly- closed block tags correctly per the HTML5 spec. Node offsets are synthetic (not byte positions in the source), so this type is not suitable for persisting reading positions to disk. Use it for ephemeral rendering such as the dictionary view.

For documents where offset accuracy matters (EPUB spine chapters, standalone HTML files) use HtmlDocument instead.

Fields

base: HtmlBase

Shared rendering state (tree, engine, page cache, stylesheets).

Implementations

impl Html5Document

pub fn new_from_memory(text: &str) -> Html5Document

Parses an in-memory HTML string using html5ever and returns a ready-to-render document.

Defaults to the dictionary viewer and user stylesheets; call set_viewer_stylesheet and set_user_stylesheet to override them.

pub fn update(&mut self, text: &str)

Replaces the document content with a freshly parsed version of text and clears the page cache.

pub fn set_viewer_stylesheet<P: AsRef<Path>>(&mut self, path: P)

Overrides the viewer stylesheet path. Clears the page cache.

pub fn set_user_stylesheet<P: AsRef<Path>>(&mut self, path: P)

Overrides the user stylesheet path. Clears the page cache.

Trait Implementations

impl Document for Html5Document

fn dims(&self, _index: usize) -> Option<(f32, f32)>

Returns the current page dimensions in pixels as (width, height).

fn pages_count(&self) -> usize

Returns the byte length of the source content as a proxy for page count.

fn toc(&mut self) -> Option<Vec<TocEntry>>

Always returns None; the dictionary has no table of contents.

fn chapter<'a>( &mut self, _offset: usize, _toc: &'a [TocEntry], ) -> Option<(&'a TocEntry, f32)>

Always returns None; chapter metadata is not applicable.

fn chapter_relative<'a>( &mut self, _offset: usize, _dir: CycleDir, _toc: &'a [TocEntry], ) -> Option<&'a TocEntry>

Always returns None; chapter-relative navigation is not applicable.

fn lines(&mut self, _loc: Location) -> Option<(Vec<BoundedText>, usize)>

Always returns None; line-level layout is not exposed.

fn title(&self) -> Option<String>

Always returns None; the dictionary does not expose a title.

fn author(&self) -> Option<String>

Always returns None; the dictionary does not expose an author.

fn save(&self, _path: &str) -> Result<(), Error>

No-op; Html5Document is always constructed from memory and has no file path to save to.

fn resolve_location(&mut self, loc: Location) -> Option<usize>

fn words(&mut self, loc: Location) -> Option<(Vec<BoundedText>, usize)>

fn images(&mut self, loc: Location) -> Option<(Vec<Boundary>, usize)>

fn links(&mut self, loc: Location) -> Option<(Vec<BoundedText>, usize)>

fn pixmap( &mut self, loc: Location, scale: f32, samples: usize, ) -> Option<(Pixmap, usize)>

fn layout(&mut self, width: u32, height: u32, font_size: f32, dpi: u16)

fn set_text_align(&mut self, text_align: TextAlign)

fn set_font_family(&mut self, family_name: &str, search_path: &str)

fn set_margin_width(&mut self, width: i32)

fn set_line_height(&mut self, line_height: f32)

fn set_hyphen_penalty(&mut self, hyphen_penalty: i32)

fn set_stretch_tolerance(&mut self, stretch_tolerance: f32)

fn set_ignore_document_css(&mut self, ignore: bool)

fn metadata(&self, key: &str) -> Option<String>

fn is_reflowable(&self) -> bool

fn has_synthetic_page_numbers(&self) -> bool

fn preview_pixmap( &mut self, width: f32, height: f32, samples: usize, ) -> Option<Pixmap>

impl Send for Html5Document

impl Sync for Html5Document