Struct SortedArray

pub struct SortedArray<K, V, const N: usize> { /* private fields */ }

A constant-size, zero-allocation associative container based on a sorted array.

Implementations

impl<K, V, const N: usize> SortedArray<K, V, N>

pub fn empty() -> Self

Create an empty sorted array

pub fn get_exact(&self, key: &K) -> Option<&V>

where K: Ord,

Return an entry which is an exact match for the key

pub fn insert(&mut self, key: K, value: V) -> Option<V>

where K: Ord,

Inserts an item and return the previous value if it exists.

Panics

This method will panic if called with a new key-value pair when already full.

The SortedArray should be checked to ensure that it is not already full before calling this method. It is full when the self.is_full() method returns true, which happens when self.len() == N.

pub fn remove(&mut self, key: &K) -> Option<V>

where K: Ord,

Remove an element from the sorted array

pub fn contains_key(&self, key: &K) -> bool

where K: Ord,

Check if the array contains a given element.

pub fn iter(&self) -> impl DoubleEndedIterator<Item = &SortedArrayEntry<K, V>>

A double ended iterator through the entries of the array.

pub fn split_off(&mut self, split_idx: usize) -> Self

Splits this SortedArray into two. self will retain all key-value pairs before the provided split index. Returns a new SortedArray created out of all key-value pairs at or after the provided split index.

pub fn get_lower_bound(&self, key: &K) -> Option<&V>

where K: Ord,

Get the key-value pair that is less than or equal to the provided key.

pub fn get_lower_bound_always(&self, key: &K) -> &V

where K: Ord,

Get the key-value pair that is less than or equal to the provided key, or the first key-value pair.

impl<K, V, const N: usize> SortedArray<K, V, N>

pub fn entries(&self) -> &[SortedArrayEntry<K, V>]

Borrow a slice view into the entries stored in the SortedArray

pub fn get_index(&self, index: usize) -> Option<&SortedArrayEntry<K, V>>

Get a key-value pair based on its internal relative index in the backing array.

pub fn first(&self) -> Option<&SortedArrayEntry<K, V>>

Returns the first key-value pair in the array, if any exists.

pub fn last(&self) -> Option<&SortedArrayEntry<K, V>>

Returns the last key-value pair in the array, if any exists.

pub fn is_full(&self) -> bool

Returns whether this array is at its maximum capacity and unable to receive additional data.

pub fn len(&self) -> usize

Returns the number of elements in the array.

pub fn is_empty(&self) -> bool

Returns whether the array has any elements.

Trait Implementations

impl<K: Clone, V: Clone, const N: usize> Clone for SortedArray<K, V, N>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug, const N: usize> Debug for SortedArray<K, V, N>

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

Formats the value using the given formatter.

impl<K, V, const N: usize> Default for SortedArray<K, V, N>

fn default() -> Self

Returns the “default value” for a type.

impl<K, V, const N: usize> PartialEq for SortedArray<K, V, N>

where K: PartialEq, V: PartialEq,

fn eq(&self, other: &Self) -> 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<K, V, const N: usize> Eq for SortedArray<K, V, N>

where K: PartialEq, V: PartialEq,