Struct Node

pub struct Node<TP: TreeProperties> { /* private fields */ }

Node in tree

Implementations

impl<TP: TreeProperties> Node<TP>

pub fn get_key(&self) -> &TP::Key

Get key of node

pub fn get_value(&self) -> &TP::Value

Get value of node

pub fn get_value_mut(&mut self) -> &mut TP::Value

Get mutable value of node

pub fn is_leaf(&self) -> bool

Whether node is a leaf

pub fn get_leaf_value(&self) -> Option<&TP::LeafValue>

Return reference to leaf value if node is a leaf

pub fn get_leaf_value_mut(&mut self) -> Option<&mut TP::LeafValue>

Return mutable reference to leaf value if node is a leaf

pub fn set_leaf_value(&mut self, value: TP::LeafValue) -> &mut TP::LeafValue

Make node a leaf node (i.e. drop potential child nodes) and set leaf value

pub fn get_or_make_leaf_value_with<F>(&mut self, f: F) -> &mut TP::LeafValue

where F: FnOnce() -> TP::LeafValue,

Return mutable reference to leaf value

If node isn’t a leaf, make it one and initialize it with given constructor

pub fn get_children(&self) -> Option<(&Self, &Self)>

Return reference to (left, right) child nodes unless node is a leaf

pub fn get_children_mut(&mut self) -> Option<(&mut Self, &mut Self)>

Return mutable reference to (left, right) child nodes unless node is a leaf

pub fn get_left(&self) -> Option<&Self>

Return reference to left child node unless node is a leaf

pub fn get_left_mut(&mut self) -> Option<&mut Self>

Return mutable reference to left child node unless node is a leaf

pub fn get_right(&self) -> Option<&Self>

Return reference to right child node unless node is a leaf

pub fn get_right_mut(&mut self) -> Option<&mut Self>

Return mutable reference to right child node unless node is a leaf

pub fn get_child(&self, side_bit: bool) -> Option<&Node<TP>>

Return reference to requested child node unless node is a leaf

false returns left and true returns right node.

pub fn get_child_mut(&mut self, side_bit: bool) -> Option<&mut Node<TP>>

Return mutable reference to requested child node unless node is a leaf

false returns left and true returns right node.

Trait Implementations

impl<TP> Clone for Node<TP>

where TP: TreeProperties, TP::Value: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TP> Debug for Node<TP>

where TP: TreeProperties, TP::Key: Debug, TP::Value: Debug, TP::LeafValue: Debug,

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

Formats the value using the given formatter.