Struct InvalidationBatch

pub struct InvalidationBatch<'a>(/* private fields */);

A batch of invalidations across one or more windows.

This type helps background tasks synchronize when to invalidate or redraw a widget. Without this type, if a tracked dynamic is changed, the window is immediately sent a request to redraw itself. These requests are batched to ensure efficiency, but if a background task is updating several dynamics independent of one another, it may desire that those updates only trigger one redraw per “step”.

The closure invoked by InvalidationBatch::batch will gather all invalidations into a single batch that can be executed by the handle provided or automatically when the closure returns.

Implementations

impl InvalidationBatch<'_>

pub fn batch(batched: impl FnOnce(&InvalidationBatch<'_>))

Executes batched gathering all tracked invalidations into a shared batch.

The closure accepts an &InvalidationBatch<'_> parameter which can be used to invoke() the batch on-demand while during batched.

This function supports nested invocation. When nested, only the outermost batch can manually invoke. When the outermost batch’s callback ends, any pending invalidations are invoked automatically.

pub fn invoke(&self)

Invokes all pending invalidations.

This function is a no-op if self is a nested batch. Only the root batch of each thread can trigger invalidations manually.