Struct Node

pub struct Node<U, T> { /* private fields */ }

Describes a node inside the Tree U: is the type for the node indentifier (must implement PartialEq) T: is the type for the node value

Implementations

impl<U, T> Node<U, T>

where U: PartialEq,

pub fn new(id: U, value: T) -> Node<U, T>

Instantiates a new Node. In order to use query methods the ID should be unique for each node in the tree

pub fn with_children(self, children: Vec<Node<U, T>>) -> Node<U, T>

Sets Node children

pub fn with_child(self, child: Node<U, T>) -> Node<U, T>

Create a new child in this Node

pub fn id(&self) -> &U

Get reference to id

pub fn value(&self) -> &T

Get reference to Node value

pub fn set_value(&mut self, value: T)

Set the value of the Node

pub fn children(&self) -> &[Node<U, T>]

Returns a reference to the Node’s children

pub fn iter(&self) -> Iter<'_, Node<U, T>>

Returns an iterator over Node’s children

pub fn iter_mut(&mut self) -> IterMut<'_, Node<U, T>>

Returns a mutable iterator over Node’s children

pub fn add_child(&mut self, child: Node<U, T>)

Add a child to the Node

If the child already exists, it will be replaced

pub fn remove_child(&mut self, id: &U)

Remove child from Node

pub fn clear(&mut self)

Clear Node’s children

pub fn truncate(&mut self, depth: usize)

Truncate tree at depth. If depth is 0, Node’s children will be cleared

pub fn sort<F>(&mut self, compare: F)

where F: FnMut(&Node<U, T>, &Node<U, T>) -> Ordering,

Sort node children by predicate

pub fn is_leaf(&self) -> bool

Returns whether this Node is a leaf (which means it has no children)

pub fn query(&self, id: &U) -> Option<&Node<U, T>>

Search for id inside Node and return a reference to it, if exists

pub fn query_mut(&mut self, id: &U) -> Option<&mut Node<U, T>>

Search for id inside Node and return a mutable reference to it, if exists

pub fn find<P>(&self, predicate: &P) -> Vec<&Node<U, T>>

where P: Fn(&Node<U, T>) -> bool,

Find a node, in this branch, by predicate.

pub fn count(&self) -> usize

Count items in tree (including self)

pub fn depth(&self) -> usize

Calculate the maximum depth of the tree

pub fn parent(&self, id: &U) -> Option<&Node<U, T>>

Get parent Node of id

pub fn parent_mut(&mut self, id: &U) -> Option<&mut Node<U, T>>

Get mutable parent Node of id

pub fn siblings(&self, id: &U) -> Option<Vec<&U>>

Get siblings for provided Node

pub fn node_by_route(&self, route: &[usize]) -> Option<&Node<U, T>>

Given a vector of indexes, returns the node associated to the route

pub fn node_by_route_mut(&mut self, route: &[usize]) -> Option<&mut Node<U, T>>

Given a vector of indexes, returns the mutable Node associated to the route

pub fn route_by_node(&self, id: &U) -> Option<Vec<usize>>

Calculate the route of a Node by its id

Trait Implementations

impl<U, T> Clone for Node<U, T>

where U: Clone, T: Clone,

fn clone(&self) -> Node<U, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<U, T> Debug for Node<U, T>

where U: Debug, T: Debug,

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

Formats the value using the given formatter.

impl<U, T> PartialEq for Node<U, T>

where U: PartialEq, T: PartialEq,

fn eq(&self, other: &Node<U, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<U, T> Eq for Node<U, T>

where U: Eq, T: Eq,

impl<U, T> StructuralPartialEq for Node<U, T>