Struct TreeModel

Source
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>
where T: Clone + Eq + Hash + Debug,

Source

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);
Source

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);
Source

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);
Source

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());
Source

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);
Source

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);
Source

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");
Source

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));
Source

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()));
Source

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]);
Source

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));
Source

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);
Source

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 });
Source

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§

Source§

impl<T: Clone> Clone for TreeModel<T>

Source§

fn clone(&self) -> TreeModel<T>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for TreeModel<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Default for TreeModel<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<A> IntoClickAction<A> for A
where A: Clone + 'static,

§

fn into_click_action(self) -> ClickAction<A>

Implements the into_click_action helper used by this module.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Props for T
where T: Clone + 'static,