Struct orange_trees::Node

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

Node

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: PartialEq, T> Node<U, T>

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

new

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>>) -> Self

with_children

Sets Node children

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

with_child

Create a new child in this Node

pub fn id(&self) -> &U

id

Get reference to id

pub fn value(&self) -> &T

value

Get reference to node value

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

children

Returns a reference to the node’s children

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

iter

Returns an iterator over node’s children

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

iter_mut

Returns a mutable iterator over node’s children

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

add_child

Add a child to the node

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

remove_child

Remove child from node

pub fn clear(&mut self)

clear

Clear node children

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

truncate

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

Sort node children by predicate

pub fn is_leaf(&self) -> bool

is_leaf

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

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

query

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

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

query_mut

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

pub fn find<P>(&self, predicate: &P) -> Vec<&Self> where
    P: Fn(&Self) -> bool, 

find

Find a node, in this branch, by predicate.

pub fn count(&self) -> usize

count

Count items in tree (including self)

pub fn depth(&self) -> usize

depth

Calculate the maximum depth of the tree

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

parent

Get parent node of id

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

siblings

Get siblings for provided node

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

node_by_route

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

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

route_by_node

Calculate the route of a node by its id

Trait Implementations

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

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: Debug, T: Debug> Debug for Node<U, T>

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

Formats the value using the given formatter.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

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

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

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