Struct im_pathtree::PathTree

pub struct PathTree<T>where
    T: PathTreeTypes,{ /* private fields */ }

Cheaply clonable path tree structure.

Could be shared safely between multiple threads.

Implementations

impl<T: PathTreeTypes> PathTree<T>

pub fn new(value: NodeValue<T>) -> Self

Create a new path tree with the given root node.

pub fn root_node_id(&self) -> NodeId

pub fn root_node(&self) -> &Arc<TreeNode<T>>

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

pub fn lookup_node(&self, id: NodeId) -> Option<&Arc<TreeNode<T>>>

pub fn find_node(&self, path: &T::RootPath) -> Option<&Arc<TreeNode<T>>>

pub fn insert_or_update_node_value( &mut self, path: &T::RootPath, new_value: NodeValue<T>, new_inner_value: impl FnMut() -> T::InnerValue ) -> Result<ParentChildTreeNode<T>, InsertOrUpdateNodeValueError<T>>

Insert or update a node in the tree.

All missing parent nodes are created recursively and initialized with the inner default value.

Returns the parent node and the inserted/updated child node. Both require updating the parent node as well.

In case of an error, the new value is returned back to the caller.

pub fn remove_subtree(&mut self, node_id: NodeId) -> Option<RemovedSubTree<T>>

Remove a node and its children from the tree.

Removes the entire subtree rooted at the given node.

The root node cannot be removed.

Returns the ID of the parent node and the IDs of the removed nodes.

pub fn node_count(&self) -> usize

pub fn count_child_nodes_recursively( &self, parent_node_id: NodeId ) -> Option<usize>

Trait Implementations

impl<T> Clone for PathTree<T>where T: PathTreeTypes + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for PathTree<T>where T: PathTreeTypes + Debug,

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

Formats the value using the given formatter.