Enum Invalidation

#[non_exhaustive]
pub enum Invalidation {
    Paint,
    Layout,
    Build,
}

Smallest unit of retained UI work requested for an element.

The ordering is intentional: several requests for the same element are coalesced to the strongest level (Paint < Layout < Build). Hosts only see the aggregate FrameWorkPlan; exact element roots remain runtime-local. The enum is non-exhaustive so downstream matches require a wildcard arm.

Examples

use ailloli_ui_runtime::app::Invalidation;
assert!(Invalidation::Paint < Invalidation::Layout);
assert!(Invalidation::Layout < Invalidation::Build);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Paint

Repaint from already reconciled and laid-out retained state.

Layout

Recompute layout, then paint. Ancestors may be affected; siblings are not invalidated unless their own inputs or constraints change.

Build

Rebuild the owning component, then layout and paint its affected path.

Implementations

impl Invalidation

Provides the operations defined for Invalidation.

pub const fn rank(self) -> u8

Returns the stable coalescing rank: paint 0, layout 1, build 2.

Examples

use ailloli_ui_runtime::app::Invalidation;
assert_eq!(Invalidation::Paint.rank(), 0);
assert_eq!(Invalidation::Layout.rank(), 1);
assert_eq!(Invalidation::Build.rank(), 2);

pub const fn merge(self, other: Self) -> Self

Coalesces two requests without losing the stronger unit of work.

The operation is commutative, associative, and idempotent for the current variants; it returns whichever value has the greater Self::rank.

Examples

use ailloli_ui_runtime::app::Invalidation;
assert_eq!(Invalidation::Paint.merge(Invalidation::Build), Invalidation::Build);
assert_eq!(Invalidation::Layout.merge(Invalidation::Paint), Invalidation::Layout);

pub const fn needs_build(self) -> bool

Returns true only for component-build invalidation.

Examples

use ailloli_ui_runtime::app::Invalidation;
assert!(Invalidation::Build.needs_build());
assert!(!Invalidation::Layout.needs_build());

pub const fn needs_layout(self) -> bool

Returns true for layout and build invalidations.

Build implies the layout pass that follows reconciliation.

Examples

use ailloli_ui_runtime::app::Invalidation;
assert!(!Invalidation::Paint.needs_layout());
assert!(Invalidation::Layout.needs_layout());
assert!(Invalidation::Build.needs_layout());

pub const fn needs_paint(self) -> bool

Returns true for every current invalidation strength.

Any retained-work request ultimately requires painting a presented frame.

Examples

use ailloli_ui_runtime::app::Invalidation;
assert!(Invalidation::Paint.needs_paint());
assert!(Invalidation::Build.needs_paint());

Trait Implementations

impl Clone for Invalidation

fn clone(&self) -> Invalidation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Invalidation

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

Formats the value using the given formatter.

impl Hash for Invalidation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Invalidation

Implements the Ord contract for Invalidation.

fn cmp(&self, other: &Self) -> Ordering

Compares two values using the documented total order.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Invalidation

fn eq(&self, other: &Invalidation) -> 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 PartialOrd for Invalidation

Implements the PartialOrd contract for Invalidation.

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

Delegates partial comparison to the total order.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Invalidation

impl Eq for Invalidation

impl StructuralPartialEq for Invalidation