Struct RenderEngine 

pub struct RenderEngine { /* private fields */ }

Render engine for chapter -> page conversion.

Implementations

impl RenderEngine

pub fn new(opts: RenderEngineOptions) -> Self

Create a render engine.

pub fn set_diagnostic_sink<F>(&mut self, sink: F)

where F: FnMut(RenderDiagnostic) + Send + 'static,

Register or replace the diagnostics sink.

pub fn pagination_profile_id(&self) -> PaginationProfileId

Stable fingerprint for all layout-affecting settings.

pub fn begin<'a>( &'a self, chapter_index: usize, config: RenderConfig<'a>, ) -> LayoutSession<'a>

Begin a chapter layout session for embedded/incremental integrations.

pub fn prepare_chapter<R: Read + Seek>( &self, book: &mut EpubBook<R>, chapter_index: usize, ) -> Result<Vec<RenderPage>, RenderEngineError>

Prepare and layout a chapter into render pages.

pub fn prepare_chapter_with_config_collect<R: Read + Seek>( &self, book: &mut EpubBook<R>, chapter_index: usize, config: RenderConfig<'_>, ) -> Result<Vec<RenderPage>, RenderEngineError>

Prepare and layout a chapter into render pages with explicit run config.

pub fn prepare_chapter_with<R, F>( &self, book: &mut EpubBook<R>, chapter_index: usize, on_page: F, ) -> Result<(), RenderEngineError>

where R: Read + Seek, F: FnMut(RenderPage),

Prepare and layout a chapter and stream each page.

pub fn prepare_chapter_with_config<R, F>( &self, book: &mut EpubBook<R>, chapter_index: usize, config: RenderConfig<'_>, on_page: F, ) -> Result<(), RenderEngineError>

where R: Read + Seek, F: FnMut(RenderPage),

Prepare and layout a chapter with explicit config and stream each page.

pub fn prepare_chapter_bytes_with<R, F>( &self, book: &mut EpubBook<R>, chapter_index: usize, html: &[u8], on_page: F, ) -> Result<(), RenderEngineError>

where R: Read + Seek, F: FnMut(RenderPage),

Prepare and layout caller-provided chapter bytes and stream each page.

This path avoids internal chapter-byte allocation and is intended for embedded call sites that keep a reusable chapter buffer.

pub fn prepare_chapter_bytes_with_config<R, F>( &self, book: &mut EpubBook<R>, chapter_index: usize, html: &[u8], config: RenderConfig<'_>, on_page: F, ) -> Result<(), RenderEngineError>

where R: Read + Seek, F: FnMut(RenderPage),

Prepare and layout caller-provided chapter bytes with explicit config.

pub fn prepare_chapter_with_cancel<R, C, F>( &self, book: &mut EpubBook<R>, chapter_index: usize, cancel: &C, on_page: F, ) -> Result<(), RenderEngineError>

where R: Read + Seek, C: CancelToken, F: FnMut(RenderPage),

Prepare and layout a chapter while honoring cancellation.

pub fn prepare_chapter_page_range<R: Read + Seek>( &self, book: &mut EpubBook<R>, chapter_index: usize, start: usize, end: usize, ) -> Result<Vec<RenderPage>, RenderEngineError>

Prepare and layout a chapter, returning pages within [start, end).

Range indices are zero-based over the emitted chapter page sequence. Returned RenderPage::page_number values remain 1-based chapter page numbers.

pub fn page_range<R: Read + Seek>( &self, book: &mut EpubBook<R>, chapter_index: usize, range: PageRange, ) -> Result<Vec<RenderPage>, RenderEngineError>

Alias for chapter page range rendering.

pub fn prepare_chapter_iter<R: Read + Seek>( &self, book: &mut EpubBook<R>, chapter_index: usize, ) -> Result<RenderPageIter, RenderEngineError>

Prepare and layout a chapter and return pages as an iterator.

This iterator is eager: pages are prepared first, then iterated.

pub fn prepare_chapter_iter_streaming<R>( &self, book: EpubBook<R>, chapter_index: usize, ) -> RenderPageStreamIter

where R: Read + Seek + Send + 'static,

Prepare and layout a chapter as a streaming iterator.

Unlike prepare_chapter_iter, this method streams pages incrementally from a worker thread using a bounded channel (capacity=1) for backpressure. It requires ownership of the book so the worker can read resources directly.

pub fn prepare_chapter_with_overlay_composer<R, O, F>( &self, book: &mut EpubBook<R>, chapter_index: usize, viewport: OverlaySize, composer: &O, on_page: F, ) -> Result<(), RenderEngineError>

where R: Read + Seek, O: OverlayComposer, F: FnMut(RenderPage),

Prepare with an overlay composer that maps page metrics into overlay items.

Trait Implementations

impl Clone for RenderEngine

fn clone(&self) -> RenderEngine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderEngine

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

Formats the value using the given formatter.