Struct starling::tree::tree_branch::TreeBranch

pub struct TreeBranch<ArrayType> where
    ArrayType: Array,  { /* fields omitted */ }

A struct representing a branch in the tree.

Trait Implementations

impl<ArrayType> Branch<ArrayType> for TreeBranch<ArrayType> where
    ArrayType: Array, 

fn new() -> Self

Creates a new Branch.

fn get_count(&self) -> u64

Gets the count of leaves beneath this node.

fn get_zero(&self) -> &ArrayType

Gets the location of the zero branch beneath this node.

fn get_one(&self) -> &ArrayType

Gets the location of the one branch beneath this node.

fn get_split_index(&self) -> usize

Gets the index on which to split keys when traversing this node.

fn get_key(&self) -> &ArrayType

Gets the associated key with this node.

fn set_count(&mut self, count: u64)

Sets the count of leaves below this node.

fn set_zero(&mut self, zero: ArrayType)

Sets the location of the zero branch beneath this node.

fn set_one(&mut self, one: ArrayType)

Sets the location of the one branch beneath this node..

fn set_split_index(&mut self, index: usize)

Sets the index on which to split keys when traversing this node.

fn set_key(&mut self, key: ArrayType)

Sets the associated key for this node.

fn decompose(self) -> (u64, ArrayType, ArrayType, usize, ArrayType)

Decomposes the Branch into its constituent parts.

impl<ArrayType: Clone> Clone for TreeBranch<ArrayType> where
    ArrayType: Array, 

fn clone(&self) -> TreeBranch<ArrayType>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<ArrayType: Copy> Copy for TreeBranch<ArrayType> where
    ArrayType: Array, 

impl<ArrayType: Debug> Debug for TreeBranch<ArrayType> where
    ArrayType: Array, 

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

Formats the value using the given formatter.

impl<ArrayType: Eq> Eq for TreeBranch<ArrayType> where
    ArrayType: Array, 

impl<ArrayType> Node<TreeBranch<ArrayType>, TreeLeaf<ArrayType>, TreeData, ArrayType> for TreeNode<ArrayType> where
    ArrayType: Array, 

fn new(
    node_variant: NodeVariant<TreeBranch<ArrayType>, TreeLeaf<ArrayType>, TreeData, ArrayType>
) -> Self

Creates a new Node.

fn get_references(&self) -> u64

Gets the number of references to this node.

fn get_variant(
    self
) -> NodeVariant<TreeBranch<ArrayType>, TreeLeaf<ArrayType>, TreeData, ArrayType>

Decomposes the struct into its inner type.

fn set_references(&mut self, references: u64)

Sets the number of references to this node.

fn set_branch(&mut self, branch: TreeBranch<ArrayType>)

Sets the node to contain a Branch node. Mutually exclusive with set_data and set_leaf.

fn set_leaf(&mut self, leaf: TreeLeaf<ArrayType>)

Sets the node to contain a Leaf node. Mututally exclusive with set_data and set_branch.

fn set_data(&mut self, data: TreeData)

Sets the node to contain a Data node. Mutually exclusive with set_leaf and set_branch.

impl<ArrayType: PartialEq> PartialEq<TreeBranch<ArrayType>> for TreeBranch<ArrayType> where
    ArrayType: Array, 

fn eq(&self, other: &TreeBranch<ArrayType>) -> bool

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

fn ne(&self, other: &TreeBranch<ArrayType>) -> bool

This method tests for !=.

impl<ArrayType> StructuralEq for TreeBranch<ArrayType> where
    ArrayType: Array, 

impl<ArrayType> StructuralPartialEq for TreeBranch<ArrayType> where
    ArrayType: Array,