pub struct TreeModel<T> { /* private fields */ }Expand description
Retained hierarchical model with stable identifiers and an incremental presentation revision.
IDs must remain globally unique for the lifetime of a model: removal retires an ID and its descendants. Mutations are atomic, and visible rows are cached persistently for cheap layout/paint access.
§Examples
use ailloli_ui_widgets::controls::{TreeItem, TreeModel, TreeMutation};
let mut model = TreeModel::new();
model.apply(TreeMutation::Insert { parent: None, index: 0, item: TreeItem::branch(1, "root") }).unwrap();
assert_eq!((model.len(), model.visible_len(), model.revision()), (1, 1, 1));Implementations§
Source§impl<T> TreeModel<T>
impl<T> TreeModel<T>
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates an empty revision-zero model.
§Examples
use ailloli_ui_widgets::controls::TreeModel;
let model = TreeModel::<u64>::new();
assert!(model.is_empty());
assert_eq!(model.revision(), 0);Sourcepub const fn revision(&self) -> u64
pub const fn revision(&self) -> u64
Returns the current transaction revision.
Successful nonempty batches increment once; empty batches and failed batches leave it unchanged.
§Examples
use ailloli_ui_widgets::controls::TreeModel;
assert_eq!(TreeModel::<u8>::new().revision(), 0);Sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Returns active item count, including currently hidden descendants.
§Examples
use ailloli_ui_widgets::controls::TreeModel;
assert_eq!(TreeModel::<u8>::new().len(), 0);Sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Reports whether the model contains no active items.
§Examples
use ailloli_ui_widgets::controls::TreeModel;
assert!(TreeModel::<u8>::new().is_empty());Sourcepub fn visible_len(&self) -> usize
pub fn visible_len(&self) -> usize
Returns cached visible row count under current expansion state.
§Examples
use ailloli_ui_widgets::controls::{TreeItem, TreeModel, TreeMutation};
let mut model = TreeModel::new();
model.apply(TreeMutation::Insert { parent: None, index: 0, item: TreeItem::leaf(1, "file") }).unwrap();
assert_eq!(model.visible_len(), 1);Sourcepub fn flat_index(&self) -> &FlatTreeIndex<T>
pub fn flat_index(&self) -> &FlatTreeIndex<T>
Borrows the persistent visible-row index.
§Examples
use ailloli_ui_widgets::controls::TreeModel;
assert_eq!(TreeModel::<u8>::new().flat_index().revision(), 0);Sourcepub fn item(&self, id: &T) -> Option<&TreeItem<T>>
pub fn item(&self, id: &T) -> Option<&TreeItem<T>>
Borrows active item metadata by ID.
Returns None for missing and retired IDs.
§Examples
use ailloli_ui_widgets::controls::{TreeItem, TreeModel, TreeMutation};
let mut model = TreeModel::new();
model.apply(TreeMutation::Insert { parent: None, index: 0, item: TreeItem::leaf(1, "file") }).unwrap();
assert_eq!(model.item(&1).unwrap().label(), "file");Sourcepub fn parent(&self, id: &T) -> Option<&T>
pub fn parent(&self, id: &T) -> Option<&T>
Borrows an active item’s parent ID.
Returns None both for roots and missing IDs; use Self::item when the
distinction matters.
§Examples
use ailloli_ui_widgets::controls::{TreeItem, TreeModel, TreeMutation};
let mut model = TreeModel::new();
model.apply_batch([
TreeMutation::Insert { parent: None, index: 0, item: TreeItem::branch(1, "root") },
TreeMutation::Insert { parent: Some(1), index: 0, item: TreeItem::leaf(2, "file") },
]).unwrap();
assert_eq!(model.parent(&2), Some(&1));Sourcepub fn children(&self, id: &T) -> Option<&[T]>
pub fn children(&self, id: &T) -> Option<&[T]>
Borrows an active item’s child IDs in presentation order.
Leaves return Some(empty); missing IDs return None.
§Examples
use ailloli_ui_widgets::controls::{TreeItem, TreeModel, TreeMutation};
let mut model = TreeModel::new();
model.apply(TreeMutation::Insert { parent: None, index: 0, item: TreeItem::leaf(1, "file") }).unwrap();
assert_eq!(model.children(&1), Some([].as_slice()));Sourcepub fn roots(&self) -> &[T]
pub fn roots(&self) -> &[T]
Borrows root IDs in presentation order.
§Examples
use ailloli_ui_widgets::controls::{TreeItem, TreeModel, TreeMutation};
let mut model = TreeModel::new();
model.apply(TreeMutation::Insert { parent: None, index: 0, item: TreeItem::leaf(7, "root") }).unwrap();
assert_eq!(model.roots(), &[7]);Sourcepub fn is_expanded(&self, id: &T) -> bool
pub fn is_expanded(&self, id: &T) -> bool
Reports expansion for an active branch.
Missing IDs and leaves return false.
§Examples
use ailloli_ui_widgets::controls::{TreeItem, TreeModel, TreeMutation};
let mut model = TreeModel::new();
model.apply(TreeMutation::Insert { parent: None, index: 0, item: TreeItem::branch(1, "root") }).unwrap();
assert!(!model.is_expanded(&1));Sourcepub fn apply(
&mut self,
mutation: TreeMutation<T>,
) -> Result<TreeModelDelta<T>, TreeModelError<T>>
pub fn apply( &mut self, mutation: TreeMutation<T>, ) -> Result<TreeModelDelta<T>, TreeModelError<T>>
Atomically applies one mutation.
On validation failure the complete hierarchy, flat index, retired IDs, and revision remain unchanged.
§Errors
Returns TreeModelError for invalid IDs, parents, indices, cycles,
branch transitions, expansion, or revision overflow.
§Examples
use ailloli_ui_widgets::controls::{TreeItem, TreeModel, TreeMutation};
let mut model = TreeModel::new();
let delta = model.apply(TreeMutation::Insert { parent: None, index: 0, item: TreeItem::leaf(1, "file") }).unwrap();
assert_eq!(delta.revision(), 1);Sourcepub fn apply_batch_if_revision(
&mut self,
expected_revision: u64,
mutations: impl IntoIterator<Item = TreeMutation<T>>,
) -> Result<TreeModelDelta<T>, TreeModelError<T>>
pub fn apply_batch_if_revision( &mut self, expected_revision: u64, mutations: impl IntoIterator<Item = TreeMutation<T>>, ) -> Result<TreeModelDelta<T>, TreeModelError<T>>
Applies a batch only when the caller still observes expected_revision.
This lets worker/UI bridges reject stale structural mutations without partially changing the retained model. Revision comparison precedes input collection and validation.
§Errors
Returns TreeModelError::StaleRevision on mismatch, otherwise the same
validation errors as Self::apply_batch.
§Examples
use ailloli_ui_widgets::controls::{TreeModel, TreeModelError, TreeMutation};
let mut model = TreeModel::<u8>::new();
let error = model.apply_batch_if_revision(1, Vec::<TreeMutation<u8>>::new()).unwrap_err();
assert_eq!(error, TreeModelError::StaleRevision { expected: 1, actual: 0 });Sourcepub fn apply_batch(
&mut self,
mutations: impl IntoIterator<Item = TreeMutation<T>>,
) -> Result<TreeModelDelta<T>, TreeModelError<T>>
pub fn apply_batch( &mut self, mutations: impl IntoIterator<Item = TreeMutation<T>>, ) -> Result<TreeModelDelta<T>, TreeModelError<T>>
Atomically applies mutations in iterator order as one transaction.
Empty input succeeds without revision change. Nonempty success increments once. Batches of at least 1,024 mutations defer flat-index materialization to the transaction boundary; smaller batches splice it incrementally.
§Errors
Returns the first validation error and commits no candidate state.
§Examples
use ailloli_ui_widgets::controls::{TreeItem, TreeModel, TreeMutation};
let mut model = TreeModel::new();
let delta = model.apply_batch([
TreeMutation::Insert { parent: None, index: 0, item: TreeItem::branch(1, "root") },
TreeMutation::Insert { parent: Some(1), index: 0, item: TreeItem::leaf(2, "file") },
]).unwrap();
assert_eq!((delta.revision(), model.len()), (1, 2));Trait Implementations§
Auto Trait Implementations§
impl<T> Freeze for TreeModel<T>
impl<T> RefUnwindSafe for TreeModel<T>where
T: RefUnwindSafe,
impl<T> Send for TreeModel<T>where
T: Send,
impl<T> Sync for TreeModel<T>where
T: Sync,
impl<T> Unpin for TreeModel<T>where
T: Unpin,
impl<T> UnwindSafe for TreeModel<T>where
T: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<A> IntoClickAction<A> for Awhere
A: Clone + 'static,
impl<A> IntoClickAction<A> for Awhere
A: Clone + 'static,
§fn into_click_action(self) -> ClickAction<A>
fn into_click_action(self) -> ClickAction<A>
Implements the into_click_action helper used by this module.