Struct Store 

pub struct Store { /* private fields */ }

Owns every hook’s state, keyed by [egui::Id].

The runner (or a test) calls Store::begin_pass before the tree is drawn and Store::end_pass after every guard has been dropped.

Implementations

impl Store

pub fn new() -> Self

Create an empty store.

The [egui::Context] used for repaint requests is a placeholder until the first Store::begin_pass.

pub fn begin_pass(&mut self, ctx: &Context)

Start a new pass: bump the pass counter and adopt ctx for repaints.

pub fn in_hidden(&self) -> bool

Is a hidden leaf being drawn right now?

pub fn end_pass(&mut self)

Finish the pass: apply the deferred queue, then sweep, then warn.

Every crate::State guard must have been dropped before this is called. The deferred queue runs first so that a queued write lands on a slot that is still alive, and the collision overlay last so that it is painted over the frame it describes.

pub fn warn_on_collision(&self) -> bool

Whether id collisions are drawn as an on-screen overlay.

Defaults to cfg!(debug_assertions).

pub fn set_warn_on_collision(&mut self, warn: bool)

Turn the collision overlay on or off.

pub fn ctx(&self) -> &Context

The context repaints are requested on.

pub fn pass(&self) -> u64

The current pass number. Starts at 1 after the first begin_pass.

pub fn collisions(&self) -> Vec<Collision>

Id collisions recorded during the current pass.

pub fn len(&self) -> usize

Number of live slots.

pub fn is_empty(&self) -> bool

Whether the store holds no slots.

pub fn tree_count(&self) -> usize

Number of live layout trees, one per <View> root drawn last pass.

For tests: it is how a test asks “did scrolling a list build a tree per row?” without reaching into egui memory.

pub fn begin_suspense(&self)

Enter a <Suspense> boundary: push a counter of its own.

The stack is cleared by Store::begin_pass, so an early return out of a boundary cannot leak a counter into the next pass.

pub fn end_suspense(&self) -> usize

Leave the innermost <Suspense> boundary.

Returns how many use_futures were pending inside it. Nested boundaries keep their own count, so this only reports what nothing inner caught.

pub fn note_pending(&self)

Count one pending use_future against the innermost boundary.

Does nothing outside a boundary: a use_future with no <Suspense> above it just returns Poll::Pending to its component.

pub fn load_persisted(&mut self, json: &str)

Restore what Store::save_persisted produced.

Call this before the first pass; keys that no use_persisted asks for are kept as they are, so an unused value survives a run that never mounted its component.

pub fn save_persisted(&self) -> String

Serialise every use_persisted value into one JSON string.

Values whose component is currently mounted are read from their slot; unmounted ones come from what the sweep saved.

Trait Implementations

impl Default for Store

fn default() -> Self

Returns the “default value” for a type.