Struct Introspector

pub struct Introspector { /* private fields */ }

Can be queried for elements and their positions.

Implementations

impl Introspector

pub fn paged(pages: &[Page]) -> Self

Creates an introspector for a page list.

pub fn html(root: &HtmlElement) -> Self

Creates an introspector for HTML.

pub fn all(&self) -> impl Iterator<Item = &Content> + '_

Iterates over all locatable elements.

impl Introspector

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

Query for all matching elements.

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

Query for the first element that matches the selector.

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

Query for the first element that matches the selector.

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

Query for a unique element with the label.

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

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

pub fn pages(&self) -> NonZeroUsize

The total number pages.

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

Find the page number for the given location.

pub fn position(&self, location: Location) -> Position

Find the position for the given location.

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

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

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

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

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

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

This is used for introspector-assisted location assignment during measurement. See the “Dealing with Measurement” section of the Locator docs for more details.

Trait Implementations

impl Clone for Introspector

fn clone(&self) -> Introspector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Introspector

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

Formats the value using the given formatter.

impl Default for Introspector

fn default() -> Introspector

Returns the “default value” for a type.

impl Track for Introspector

fn track(&self) -> Tracked<'_, Self>

Start tracking all accesses to a value.

fn track_mut(&mut self) -> TrackedMut<'_, Self>

Start tracking all accesses and mutations to a value.

fn track_with<'a>( &'a self, constraint: &'a Self::Constraint, ) -> Tracked<'a, Self>

Start tracking all accesses into a constraint.

fn track_mut_with<'a>( &'a mut self, constraint: &'a Self::Constraint, ) -> TrackedMut<'a, Self>

Start tracking all accesses and mutations into a constraint.

impl Validate for Introspector

type Constraint = ImmutableConstraint<__ComemoCall>

The constraints for this type.

fn validate(&self, constraint: &Self::Constraint) -> bool

Whether this value fulfills the given constraints.

fn validate_with_id(&self, constraint: &Self::Constraint, id: usize) -> bool

Accelerated version of validate.

fn replay(&mut self, constraint: &Self::Constraint)

Replay recorded mutations to the value.