Struct RecordTree 

pub struct RecordTree<R> { /* private fields */ }

Generic tree structure for Altium records.

Provides efficient navigation of parent-child relationships that are encoded via OWNERINDEX in the original flat record list.

Implementations

impl<R: TreeRecord> RecordTree<R>

pub fn from_records(records: Vec<R>) -> Self

Build a tree from a flat list of records using OWNERINDEX relationships.

Records with OWNERINDEX < 0 or >= len are treated as roots.

pub fn len(&self) -> usize

Get the number of records in the tree.

pub fn is_empty(&self) -> bool

Check if the tree is empty.

pub fn get(&self, id: RecordId) -> Option<&R>

Get a record by ID.

pub fn get_mut(&mut self, id: RecordId) -> Option<&mut R>

Get a mutable record by ID.

pub fn get_by_index(&self, index: usize) -> Option<&R>

Get the record at a specific index.

pub fn iter(&self) -> impl Iterator<Item = (RecordId, &R)>

Iterate over all records with their IDs.

pub fn iter_mut(&mut self) -> impl Iterator<Item = (RecordId, &mut R)>

Iterate over all records mutably with their IDs.

pub fn roots(&self) -> impl Iterator<Item = (RecordId, &R)>

Get root records (records with no valid parent).

pub fn root_count(&self) -> usize

Get the number of root records.

pub fn is_root(&self, id: RecordId) -> bool

Check if a record is a root.

pub fn parent(&self, id: RecordId) -> Option<(RecordId, &R)>

Get the parent of a record.

pub fn parent_id(&self, id: RecordId) -> Option<RecordId>

Get the parent ID of a record (without the record itself).

pub fn children(&self, id: RecordId) -> impl Iterator<Item = (RecordId, &R)>

Get children of a record.

pub fn child_count(&self, id: RecordId) -> usize

Get the number of children for a record.

pub fn has_children(&self, id: RecordId) -> bool

Check if a record has children.

pub fn ancestors(&self, id: RecordId) -> impl Iterator<Item = (RecordId, &R)>

Get all ancestors of a record (parent, grandparent, etc.).

pub fn descendants(&self, id: RecordId) -> impl Iterator<Item = (RecordId, &R)>

Get all descendants of a record (children, grandchildren, etc.).

pub fn depth(&self, id: RecordId) -> usize

Get the depth of a record (0 for roots).

pub fn walk_depth_first(&self) -> TreeWalker<'_, R>

Walk the tree depth-first starting from roots.

pub fn walk_from(&self, id: RecordId) -> TreeWalker<'_, R>

Walk the tree depth-first starting from a specific node.

pub fn find<F>(&self, predicate: F) -> impl Iterator<Item = (RecordId, &R)>

where F: Fn(&R) -> bool,

Find records matching a predicate.

pub fn find_first<F>(&self, predicate: F) -> Option<(RecordId, &R)>

where F: Fn(&R) -> bool,

Find the first record matching a predicate.

pub fn path_to_root(&self, id: RecordId) -> Vec<RecordId>

Get the path from a record to the root (inclusive).

pub fn into_records(self) -> Vec<R>

Consume the tree and return the underlying records.

pub fn as_slice(&self) -> &[R]

Get a reference to the underlying records slice.

pub fn add(&mut self, record: R) -> RecordId

Add a record to the tree.

Returns the ID of the newly added record.

pub fn remove(&mut self, id: RecordId) -> Option<R>

Remove a record from the tree by ID.

Note: This invalidates all RecordIds after the removed record. Consider using a different approach for frequent removals.

pub fn reparent(&mut self, id: RecordId, new_parent: Option<RecordId>)

Move a record to a new parent.

Trait Implementations

impl<R: Clone> Clone for RecordTree<R>

fn clone(&self) -> RecordTree<R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for RecordTree<R>

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

Formats the value using the given formatter.

impl<R> Default for RecordTree<R>

fn default() -> Self

Returns the “default value” for a type.