Skip to main content

RenderPrep

Struct RenderPrep 

Source
pub struct RenderPrep { /* private fields */ }
Expand description

Render-prep orchestrator.

Implementations§

Source§

impl RenderPrep

Source

pub fn new(opts: RenderPrepOptions) -> Self

Create a render-prep engine.

Source

pub fn with_serif_default(self) -> Self

Use serif default fallback policy.

Source

pub fn with_font_policy(self, policy: FontPolicy) -> Self

Override fallback font policy used during style-to-face resolution.

Source

pub fn with_embedded_fonts_from_book<R: Read + Seek>( self, book: &mut EpubBook<R>, ) -> Result<Self, RenderPrepError>

Register all embedded fonts from a book.

Source

pub fn with_registered_fonts<I, F>( self, fonts: I, loader: F, ) -> Result<Self, RenderPrepError>

Register fonts from any external source with a byte loader callback.

Source

pub fn prepare_chapter<R: Read + Seek>( &mut self, book: &mut EpubBook<R>, index: usize, ) -> Result<PreparedChapter, RenderPrepError>

Prepare a chapter into styled runs/events.

Source

pub fn prepare_chapter_into<R: Read + Seek>( &mut self, book: &mut EpubBook<R>, index: usize, out: &mut Vec<StyledEventOrRun>, ) -> Result<(), RenderPrepError>

Prepare a chapter and append results into an output buffer.

Source

pub fn prepare_chapter_with<R: Read + Seek, F: FnMut(StyledEventOrRun)>( &mut self, book: &mut EpubBook<R>, index: usize, on_item: F, ) -> Result<(), RenderPrepError>

Prepare a chapter and stream each styled item via callback.

Source

pub fn prepare_chapter_bytes_with<R: Read + Seek, F: FnMut(StyledEventOrRun)>( &mut self, book: &mut EpubBook<R>, index: usize, html: &[u8], on_item: F, ) -> Result<(), RenderPrepError>

Prepare a chapter from caller-provided XHTML bytes and stream each styled item.

This avoids re-reading chapter bytes from the ZIP archive and is intended for embedded call sites that already own a reusable chapter buffer.

Source

pub fn prepare_chapter_bytes_with_scratch<R: Read + Seek, F: FnMut(StyledEventOrRun)>( &mut self, book: &mut EpubBook<R>, index: usize, html: &[u8], stylesheet_scratch: &mut Vec<u8>, on_item: F, ) -> Result<(), RenderPrepError>

Prepare chapter bytes with caller-provided stylesheet scratch.

This avoids transient stylesheet Vec<u8> allocations by reusing stylesheet_scratch.

Source

pub fn prepare_chapter_with_trace_context<R: Read + Seek, F: FnMut(StyledEventOrRun, RenderPrepTrace)>( &mut self, book: &mut EpubBook<R>, index: usize, on_item: F, ) -> Result<(), RenderPrepError>

Prepare a chapter and stream each styled item with structured trace context.

Source

pub fn prepare_chapter_with_trace<R: Read + Seek, F: FnMut(StyledEventOrRun, Option<FontResolutionTrace>)>( &mut self, book: &mut EpubBook<R>, index: usize, on_item: F, ) -> Result<(), RenderPrepError>

👎Deprecated since 0.2.0: Use prepare_chapter_with_trace_context for stable structured trace output.

Prepare a chapter and stream each styled item with optional font-resolution trace.

Trait Implementations§

Source§

impl Clone for RenderPrep

Source§

fn clone(&self) -> RenderPrep

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RenderPrep

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.