Struct InvalidationRecord

pub struct InvalidationRecord { /* private fields */ }

One bounded provenance record for an invalidation request.

Records are immutable snapshots. Sequence values start at one and saturate at u64::MAX; they can therefore cease being unique only after saturation. was_coalesced says an element already had pending work, not that the new request had the same strength.

Examples

use ailloli_ui_core::ElementId;
use ailloli_ui_runtime::app::{Invalidation, InvalidationSource, RuntimeHandle};
let handle = RuntimeHandle::<()>::new();
handle.invalidate_from(ElementId(7), Invalidation::Layout, InvalidationSource::Event);
let snapshot = handle.invalidation_diagnostics();
assert_eq!(snapshot.records.len(), 1);
assert_eq!(snapshot.records[0].element_id(), ElementId(7));

Implementations

impl InvalidationRecord

Provides the operations defined for InvalidationRecord.

pub const fn sequence(&self) -> u64

Returns the one-based saturating request sequence.

Examples

use ailloli_ui_core::ElementId;
use ailloli_ui_runtime::app::{Invalidation, RuntimeHandle};
let handle = RuntimeHandle::<()>::new();
handle.invalidate(ElementId(1), Invalidation::Paint);
assert_eq!(handle.invalidation_diagnostics().records[0].sequence(), 1);

pub const fn element_tree_id(&self) -> ElementTreeId

Returns the retained-tree namespace that received the request.

Examples

use ailloli_ui_core::ElementId;
use ailloli_ui_runtime::app::{Invalidation, RuntimeHandle};
let handle = RuntimeHandle::<()>::new();
handle.invalidate(ElementId(1), Invalidation::Paint);
assert_eq!(handle.invalidation_diagnostics().records[0].element_tree_id(), handle.element_tree_id());

pub const fn element_id(&self) -> ElementId

Returns the tree-local target element ID.

Examples

use ailloli_ui_core::ElementId;
use ailloli_ui_runtime::app::{Invalidation, RuntimeHandle};
let handle = RuntimeHandle::<()>::new();
handle.invalidate(ElementId(9), Invalidation::Paint);
assert_eq!(handle.invalidation_diagnostics().records[0].element_id(), ElementId(9));

pub const fn invalidation(&self) -> Invalidation

Returns the requested retained-work strength before coalescing.

Examples

use ailloli_ui_core::ElementId;
use ailloli_ui_runtime::app::{Invalidation, RuntimeHandle};
let handle = RuntimeHandle::<()>::new();
handle.invalidate(ElementId(1), Invalidation::Build);
assert_eq!(handle.invalidation_diagnostics().records[0].invalidation(), Invalidation::Build);

pub const fn source(&self) -> InvalidationSource

Returns the diagnostic origin supplied by the caller.

Examples

use ailloli_ui_core::ElementId;
use ailloli_ui_runtime::app::{Invalidation, InvalidationSource, RuntimeHandle};
let handle = RuntimeHandle::<()>::new();
handle.invalidate_from(ElementId(1), Invalidation::Paint, InvalidationSource::Model);
assert_eq!(handle.invalidation_diagnostics().records[0].source(), InvalidationSource::Model);

pub const fn was_coalesced(&self) -> bool

Returns whether the target already had a pending invalidation.

The first request is false; subsequent requests before pending work is taken are true even when they strengthen the retained-work level.

Examples

use ailloli_ui_core::ElementId;
use ailloli_ui_runtime::app::{Invalidation, RuntimeHandle};
let handle = RuntimeHandle::<()>::new();
handle.invalidate(ElementId(1), Invalidation::Paint);
handle.invalidate(ElementId(1), Invalidation::Build);
let records = handle.invalidation_diagnostics().records;
assert!(!records[0].was_coalesced());
assert!(records[1].was_coalesced());

Trait Implementations

impl Clone for InvalidationRecord

fn clone(&self) -> InvalidationRecord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InvalidationRecord

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

Formats the value using the given formatter.

impl PartialEq for InvalidationRecord

fn eq(&self, other: &InvalidationRecord) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for InvalidationRecord

impl Eq for InvalidationRecord

impl StructuralPartialEq for InvalidationRecord