Struct TreeRef 

#[non_exhaustive]
pub struct TreeRef<const N: usize> {
    pub key: Array<N>,
    pub location: Array<N>,
    pub node_count: u64,
    pub count: u32,
}

A reference to a node in the tree.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: Array<N>

The associated key with this TreeRef.

location: Array<N>

The location of the TreeRef in the tree.

node_count: u64

The total number of elements underneath this TreeRef. This represents the total number of nodes under this node in the tree.

count: u32

The number of nodes underneath this TreeRef when building the tree. This value is used in the tree building process on insert, and does not consider the total number of nodes in the tree.

Implementations

impl<const N: usize> TreeRef<N>

pub const fn new( key: Array<N>, location: Array<N>, node_count: u64, count: u32, ) -> Self

Creates a new TreeRef.

Trait Implementations

impl<const N: usize> Clone for TreeRef<N>

fn clone(&self) -> TreeRef<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for TreeRef<N>

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

Formats the value using the given formatter.

impl<const N: usize> Ord for TreeRef<N>

fn cmp(&self, other_ref: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const N: usize> PartialEq for TreeRef<N>

fn eq(&self, other: &TreeRef<N>) -> 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<const N: usize> PartialOrd for TreeRef<N>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const N: usize> Copy for TreeRef<N>

impl<const N: usize> Eq for TreeRef<N>

impl<const N: usize> StructuralPartialEq for TreeRef<N>