Skip to main content

PageMeta

Type Alias PageMeta 

Source
pub type PageMeta = PageMetrics;
Expand description

Backward-compatible alias for page-level metadata.

Aliased Type§

pub struct PageMeta {
    pub chapter_index: usize,
    pub chapter_page_index: usize,
    pub chapter_page_count: Option<usize>,
    pub global_page_index: Option<usize>,
    pub global_page_count_estimate: Option<usize>,
    pub progress_chapter: f32,
    pub progress_book: Option<f32>,
}

Fields§

§chapter_index: usize

Chapter index in the spine (0-based), when known.

§chapter_page_index: usize

Page index in chapter (0-based).

§chapter_page_count: Option<usize>

Total pages in chapter, when known.

§global_page_index: Option<usize>

Global page index across rendered stream (0-based), when known.

§global_page_count_estimate: Option<usize>

Estimated global page count, when known.

§progress_chapter: f32

Chapter progress in range [0.0, 1.0].

§progress_book: Option<f32>

Book progress in range [0.0, 1.0], when known.