Struct PagedIntrospector 

pub struct PagedIntrospector { /* private fields */ }

An introspector implementation for paged documents.

Implementations

impl PagedIntrospector

pub fn new(pages: &[Page]) -> PagedIntrospector

Creates an introspector for a paged document.

pub fn position(&self, location: Location) -> Option<PagedPosition>

Resolves the position of the location in the pages.

pub fn elements(&self) -> &ElementIntrospector<PagedPosition>

The underlying element introspector.

pub fn frame_link_targets(&self) -> &FxHashSet<Location>

Returns the locations that the paged document links to via FrameItem::Link.

Trait Implementations

impl Clone for PagedIntrospector

fn clone(&self) -> PagedIntrospector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PagedIntrospector

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

Formats the value using the given formatter.

impl Introspector for PagedIntrospector

fn query(&self, selector: &Selector) -> EcoVec<Content>

Queries for all matching elements.

fn query_first(&self, selector: &Selector) -> Option<Content>

Queries for the first element that matches the selector.

fn query_unique(&self, selector: &Selector) -> StrResult<Content>

Queries for the first element that matches the selector.

fn query_label(&self, label: Label) -> StrResult<&Content>

Queries for a unique element with the label.

fn query_labelled(&self) -> EcoVec<Content>

Queries for all elements with a label.

fn query_count_before(&self, selector: &Selector, end: Location) -> usize

An optimized version of query(selector.before(end, true).len() used by counters and state.

fn label_count(&self, label: Label) -> usize

Checks how many times a label exists.

fn locator(&self, key: u128, base: Location) -> Option<Location>

Tries to find a location for an element with the given key hash that is closest after the base.

fn pages(&self, _: Location) -> Option<NonZeroUsize>

Returns the total number of pages in the document that contains the given location.

fn page(&self, location: Location) -> Option<NonZeroUsize>

Returns the page number for the given location.

fn position(&self, location: Location) -> Option<DocumentPosition>

Returns the position for the given location.

fn page_numbering(&self, location: Location) -> Option<&Numbering>

Returns the page numbering for the given location, if any.

fn page_supplement(&self, location: Location) -> Option<&Content>

Returns the page supplement for the given location, if any.

fn anchor(&self, _: Location) -> Option<&EcoString>

Retrieves the anchor to link to for this location in HTML export.

fn document(&self, _: Location) -> Option<Location>

Returns the location of the document which has/contains the given location.

fn path(&self, _: Location) -> Option<&VirtualPath>

Returns the file path of the document/asset which has or contains the given location.