Struct FrameWorkPlan

pub struct FrameWorkPlan { /* private fields */ }

Provider-neutral aggregate consumed by a presentation host.

Element identifiers and propagation roots deliberately do not cross this boundary. The runtime retains those details for incremental reconciliation and layout.

The fields are intentionally private: hosts can ask which frame stages are necessary but cannot infer or manipulate retained element roots.

Examples

use ailloli_ui_runtime::app::{FrameWorkPlan, Invalidation};
let plan = FrameWorkPlan::from_invalidation(Invalidation::Layout);
assert!(!plan.needs_build());
assert!(plan.needs_layout() && plan.needs_paint());

Implementations

impl FrameWorkPlan

Provides the operations defined for FrameWorkPlan.

pub const fn none() -> Self

Returns a plan with no build, layout, or paint work.

This equals Default::default.

Examples

use ailloli_ui_runtime::app::FrameWorkPlan;
assert_eq!(FrameWorkPlan::none(), FrameWorkPlan::default());
assert!(FrameWorkPlan::none().is_empty());

pub const fn from_invalidation(invalidation: Invalidation) -> Self

Converts one invalidation strength into its implied frame stages.

Paint maps to paint only; layout maps to layout plus paint; build maps to all three stages.

Examples

use ailloli_ui_runtime::app::{FrameWorkPlan, Invalidation};
let plan = FrameWorkPlan::from_invalidation(Invalidation::Build);
assert!(plan.needs_build() && plan.needs_layout() && plan.needs_paint());

pub const fn needs_build(self) -> bool

Returns whether component reconciliation/build work is required.

Examples

use ailloli_ui_runtime::app::{FrameWorkPlan, Invalidation};
assert!(FrameWorkPlan::from_invalidation(Invalidation::Build).needs_build());
assert!(!FrameWorkPlan::from_invalidation(Invalidation::Layout).needs_build());

pub const fn needs_layout(self) -> bool

Returns whether retained layout work is required.

Examples

use ailloli_ui_runtime::app::{FrameWorkPlan, Invalidation};
assert!(FrameWorkPlan::from_invalidation(Invalidation::Layout).needs_layout());
assert!(!FrameWorkPlan::from_invalidation(Invalidation::Paint).needs_layout());

pub const fn needs_paint(self) -> bool

Returns whether scene painting is required.

Examples

use ailloli_ui_runtime::app::{FrameWorkPlan, Invalidation};
assert!(FrameWorkPlan::from_invalidation(Invalidation::Paint).needs_paint());
assert!(!FrameWorkPlan::none().needs_paint());

pub const fn is_empty(self) -> bool

Returns true exactly when painting is not required.

Public constructors preserve the invariant that build/layout imply paint, so this is equivalent to all stages being false.

Examples

use ailloli_ui_runtime::app::{FrameWorkPlan, Invalidation};
assert!(FrameWorkPlan::none().is_empty());
assert!(!FrameWorkPlan::from_invalidation(Invalidation::Paint).is_empty());

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

Combines two plans by OR-ing each stage flag.

Examples

use ailloli_ui_runtime::app::{FrameWorkPlan, Invalidation};
let plan = FrameWorkPlan::none().merge(FrameWorkPlan::from_invalidation(Invalidation::Layout));
assert!(!plan.needs_build());
assert!(plan.needs_layout() && plan.needs_paint());

Trait Implementations

impl Clone for FrameWorkPlan

fn clone(&self) -> FrameWorkPlan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameWorkPlan

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

Formats the value using the given formatter.

impl Default for FrameWorkPlan

fn default() -> FrameWorkPlan

Returns the “default value” for a type.

impl PartialEq for FrameWorkPlan

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

impl Eq for FrameWorkPlan

impl StructuralPartialEq for FrameWorkPlan