Struct KeyValueBucketArray

pub(crate) struct KeyValueBucketArray<'k, 'v, const N: usize, const CAP: usize, C: Count, K: Key, KS: KeyStorage<K>, V: Copy>(BucketArrayPair<'k, 'v, N, CAP, C, KS, V>, PhantomData<K>);

Concrete bucket array with parallel BucketArrayMemory for key and value storage

This is the basic data type used for one layer of sorting buckets.

Takes several type parameters so the narrowest possible types can be chosen for counters, keys, and values. Keys take two types: the ‘wide’ version that appears in the API and a ‘storage’ version that’s been stripped of the data redundant with its bucket position.

The validity of BucketArrayMemory entries is ensured by the combination of our mutable ref to the BucketArrayMemory itself and our tracking of bucket counts within the lifetime of that reference.

Tuple Fields

0: BucketArrayPair<'k, 'v, N, CAP, C, KS, V>

1: PhantomData<K>

Implementations

impl<'k, 'v, const N: usize, const CAP: usize, C: Count, K: Key, KS: KeyStorage<K>, V: Copy> KeyValueBucketArray<'k, 'v, N, CAP, C, K, KS, V>

pub(crate) fn new( key_mem: &'k mut BucketArrayMemory<N, CAP, KS>, value_mem: &'v mut BucketArrayMemory<N, CAP, V>, ) -> Self

A new KeyValueBucketArray wraps two mutable BucketArrayMemory references and adds state to track which items are valid.

pub(crate) fn drop_key_storage(self) -> ValueBucketArray<'v, N, CAP, C, K, V>

Keep the counts and the value memory but drop the key memory.

Returns a new ValueBucketArray.

Trait Implementations

impl<'k, 'v, const N: usize, const CAP: usize, C: Count, K: Key, KS: KeyStorage<K>, V: Copy> Insert<K, V> for KeyValueBucketArray<'k, 'v, N, CAP, C, K, KS, V>

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

Append a new item to its sorting bucket, or return Err(()) if it’s full

impl<'k, 'v, const N: usize, const CAP: usize, C: Count, K: Key, KS: KeyStorage<K>, V: Copy> KeyLookup<KS, K> for KeyValueBucketArray<'k, 'v, N, CAP, C, K, KS, V>

fn item_stored_key(&self, bucket: usize, item: usize) -> KS

Retrieve the stored key remainder bits for this item

fn item_full_key(&self, bucket: usize, item: usize) -> K

Retrieve the key for a particular item, as a full width key

impl<'k, 'v, const N: usize, const CAP: usize, C: Count, K: Key, KS: KeyStorage<K>, V: Copy> Shape<K> for KeyValueBucketArray<'k, 'v, N, CAP, C, K, KS, V>

const NUM_BUCKETS: usize = N

Number of buckets in the array

fn item_range(&self, bucket: usize) -> Range<usize>

Get the range of items within a single bucket.

fn divisor(&self) -> K

Get the key divisor: the number of buckets but as a Key instance.

fn split_wide_key(&self, key: K) -> (usize, K)

Split a wide key into the bucket index and the remaining bits.

fn join_wide_key(&self, bucket: usize, remainder: K) -> K

Rebuild a wide key from its split components.

impl<'k, 'v, const N: usize, const CAP: usize, C: Count, K: Key, KS: KeyStorage<K>, V: Copy> ValueLookup<V> for KeyValueBucketArray<'k, 'v, N, CAP, C, K, KS, V>

fn item_value(&self, bucket: usize, item: usize) -> V

Retrieve the Value for a particular item