Struct IncrementalLayout 

pub struct IncrementalLayout { /* private fields */ }

Incremental layout engine.

Combines a DepGraph for dirty tracking with a per-node result cache. The user drives the DFS tree walk; at each node, get_or_compute decides whether to return the cached result or call the supplied compute closure.

Implementations

impl IncrementalLayout

pub fn new() -> Self

Create an empty incremental layout engine.

pub fn with_capacity(node_cap: usize) -> Self

Create with pre-allocated capacity.

pub fn from_env() -> Self

Create from environment configuration.

Reads FRANKENTUI_FULL_LAYOUT. When set to "1", "true", or "yes" (case-insensitive), force-full mode is enabled and all get_or_compute calls bypass the cache.

pub fn add_node(&mut self, parent: Option<NodeId>) -> NodeId

Add a layout node, optionally with a parent.

When a parent is provided, a dependency edge is added so that dirtying the parent also dirties this child.

pub fn remove_node(&mut self, id: NodeId)

Remove a node and evict its cache entry.

pub fn add_dependency( &mut self, from: NodeId, to: NodeId, ) -> Result<(), CycleError>

Add a custom dependency edge: from depends on to.

Use this for bidirectional flex-sibling relationships or cross-subtree dependencies.

pub fn mark_changed(&mut self, id: NodeId, kind: InputKind, new_hash: u64)

Mark a node’s input as changed (hash-deduplicated).

The node will not be dirtied if new_hash matches the stored hash for this InputKind.

pub fn mark_dirty(&mut self, id: NodeId)

Force-mark a node as dirty without hash comparison.

pub fn mark_dirty_with_ancestors(&mut self, id: NodeId)

Mark a node dirty and also dirty all its ancestors up to the root. This implements the “flex sibling” pattern: when a child changes, its parent must recompute, which propagates to all siblings via parent→child edges.

pub fn propagate(&mut self) -> Vec<NodeId>

Propagate dirtiness from pending nodes to all transitive dependents. Must be called before get_or_compute.

Returns the dirty set in DFS pre-order.

pub fn is_dirty(&self, id: NodeId) -> bool

Check if a node is currently dirty.

pub fn get_or_compute<F>( &mut self, id: NodeId, area: Rect, compute: F, ) -> Vec<Rect>

where F: FnOnce(Rect) -> Vec<Rect>,

Get the cached layout for a node, or compute and cache it.

A cache hit requires:

1. The node is not dirty.
2. The area matches the previously cached area.
3. force_full is not enabled.

On a cache miss, compute is called with the area and the result is stored. The node is cleaned after computation.

pub fn cached_rects(&self, id: NodeId) -> Option<&[Rect]>

Retrieve the cached result for a node without recomputing.

Returns None if the node has no cached result.

pub fn result_changed(&self, id: NodeId) -> bool

Check whether a node’s last computed result changed compared to its previous result. Useful for detecting when a parent must propagate layout changes to children.

pub fn result_hash(&self, id: NodeId) -> Option<u64>

Get the hash of a node’s last computed result.

pub fn set_force_full(&mut self, force: bool)

Enable or disable force-full mode.

When enabled, every get_or_compute call recomputes from scratch, ignoring the cache. Useful for debugging or as a fallback path.

pub fn force_full(&self) -> bool

Whether force-full mode is enabled.

pub fn stats(&self) -> IncrementalStats

Current-pass statistics.

pub fn reset_stats(&mut self)

Reset per-pass statistics to zero.

pub fn clean_all(&mut self)

Mark all nodes clean and advance the generation.

pub fn invalidate_all(&mut self)

Mark all nodes dirty (forces full recomputation on next pass).

pub fn clear_cache(&mut self)

Clear the entire result cache (frees memory).

pub fn graph(&self) -> &DepGraph

Borrow the underlying dependency graph.

pub fn graph_mut(&mut self) -> &mut DepGraph

Mutable access to the dependency graph.

pub fn cache_len(&self) -> usize

Number of cached entries.

pub fn node_count(&self) -> usize

Number of live nodes in the dependency graph.

Trait Implementations

impl Debug for IncrementalLayout

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

Formats the value using the given formatter.

impl Default for IncrementalLayout

fn default() -> Self

Returns the “default value” for a type.