Struct CrossRefs 

pub struct CrossRefs { /* private fields */ }

Port of crossRef.ml’s mutable cross-reference table.

Implementations

impl CrossRefs

pub fn new() -> CrossRefs

pub fn seeded(table: AuxTable) -> CrossRefs

A table pre-populated from a previous run’s auxiliary file.

Seeding only changes how fast the fixpoint converges, never where it converges to: a seeded value a get observes and a later register contradicts still marks the layout stale and forces another trial. It mainly helps a forward reference (\ref to a later section) resolve on trial 1 instead of trial 2.

pub fn export(&self) -> AuxTable

The table as it should be written back out.

Keys this run neither read nor registered are carried through verbatim, so an auxiliary file round-trips with upstream SATySFi.

pub fn seed_unvalidated(&self) -> bool

Did the trial that just ended READ a seeded value that it never re-registered?

If so the layout depended on a value from a previous run that was never re-derived this run (e.g. a \label the document dropped but some \ref still targets) — unverifiable, not necessarily wrong. The driver’s answer is to discard the seed and redo the fixpoint cold, so a warm build is always byte-identical to a cold one.

pub fn register(&mut self, k: String, v: String)

crossRef.ml:99, plus the fixpoint-shortcut bookkeeping: if this key was already READ this trial and the value the reader saw differs from v, the layout is now stale and another trial is required. A key that is (re)registered but never read this trial does NOT force a retrial — its value cannot have affected the output — which is what lets a document that only writes cross-references (e.g. page labels nothing \refs) converge in ONE trial.

pub fn get(&mut self, k: &str) -> Option<String>

crossRef.ml:116 — records a miss (an unresolved forward reference) alongside the ordinary lookup, and remembers what the reader observed so a later register can tell whether that observation went stale.

pub fn probe(&self, k: &str) -> Option<String>

crossRef.ml:112 — like Self::get but records no miss (probe-cross-reference): probing an absent key must NOT force another fixpoint trial.

pub fn verdict(&mut self) -> Verdict

crossRef.ml:78 needs_another_trial, tightened: retry only if a value the layout READ this trial was invalidated (stale), not on every (re)registration. Consumes this trial’s bookkeeping and resets it.

Trait Implementations

impl Debug for CrossRefs

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

Formats the value using the given formatter.

impl Default for CrossRefs

fn default() -> CrossRefs

Returns the “default value” for a type.