Struct ExampleStaticMapU16

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

Implementations

impl<V, const N: usize> ExampleStaticMapU16<u16, V, N>

pub fn insert_move(&mut self, key: u16, value: V) -> Result<(), NotEnoughSpace>

Inserts a key-value pair, consuming the value.

pub fn replace(&mut self, key: u16, replacement: V) -> Option<V>

Removes and returns the value for a given key, replacing it with a provided value.

pub fn replace_default(&mut self, key: u16) -> Option<V>

where V: Default,

Removes and returns the value for a given key, replacing it with V::default().

pub fn replace_with<F>(&mut self, key: u16, replacement: F) -> Option<V>

where F: FnOnce() -> V,

Removes and returns the value for a given key, replacing it with a custom value.

pub const fn capacity(&self) -> usize

Returns the total capacity of the hashmap (fixed at N).

pub const fn hash_index(&self, key: u16) -> usize

Computes a hash index.

impl<V, const N: usize> ExampleStaticMapU16<u16, V, N>

pub fn empty(&self) -> u16

Returns the key value used to mark empty slots.

pub fn tomb(&self) -> u16

Returns the key value used to mark deleted slots.

impl<V, const N: usize> ExampleStaticMapU16<u16, V, N>

pub fn new() -> Self

where V: Default,

Constructs a new static map with runtime EMPTY and TOMB values.

pub fn get_ref(&self, key: u16) -> Option<&V>

Retrieves some shared reference to the value associated with the given key.

pub fn get_mut(&mut self, key: u16) -> Option<&mut V>

Retrieves some exclusive reference to the value associated with the given key.

pub fn entry(&mut self, key: u16) -> StaticMapEntry<'_, V>

Retrieves an entry for a given key.

pub fn len(&self) -> usize

Returns the number of occupied slots in the hashmap.

pub fn is_empty(&self) -> bool

Returns true if the hashmap contains no entries.

pub fn is_full(&self) -> bool

Returns true if the hashmap is completely full.

pub fn should_rebuild(&self) -> bool

Determines if rebuilding the table would improve efficiency.

Heuristic:

• Rebuild if TOMB slots exceed N / 2 (half the table size).

pub fn deleted_count(&self) -> usize

Returns the number of deleted (TOMB) slots.

pub fn load_factor(&self) -> f32

Returns the load factor as a fraction of total capacity.

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

Inserts a key-value pair.

Returns

• Ok(()) if the insertion succeeds.
• Err([NotEnoughSpace]) if no slots are available.

Behavior

• Computes the hash index of the key.
• If the slot is EMPTY, inserts immediately.
• If the slot contains TOMB, the first TOMB encountered is used if no empty slots exist earlier in probing.
• If the slot contains another key, probes forward until an open slot is found.
• If no open slots exist, returns an error.

impl<V: Copy, const N: usize> ExampleStaticMapU16<u16, V, N>

pub fn get(&self, key: u16) -> Option<V>

Retrieves a value by key.

Returns

• Some(value) if the key exists.
• None if the key is missing.

Behavior

• Searches for the key using linear probing.
• If a TOMB (deleted slot) is encountered, it continues probing.
• If an EMPTY slot is reached, the key is not in the table.

pub fn remove(&mut self, key: u16) -> bool

Removes a key-value pair.

Returns

• true if the key was found and removed.
• false if the key was not found in the map.

Behavior

• Marks the slot as deleted (TOMB).
• Future lookups will continue probing past deleted entries.
• Does NOT free the slot for immediate reuse.
• New insertions only reuse a TOMB slot if no earlier EMPTY slots exist.

impl<V: Copy + Default, const N: usize> ExampleStaticMapU16<u16, V, N>

pub fn remove_rebuild(&mut self, key: u16) -> bool

Removes a key-value pair and optionally rebuilds the table.

Behavior

• Calls remove(), returning true if the key was found.
• If should_rebuild() returns true, calls rebuild().

pub fn rebuild(&mut self)

Rebuilds the table by removing TOMB slots and optimizing key placement.

Calls Self::rebuilt() and replaces self with the optimized table.

When to Call?

• When many deletions have occurred.
• If lookups start taking significantly longer.

pub fn rebuilt(&self) -> Self

Returns a rebuilt version of the table with TOMB slots removed.

Creates a new table and reinserts all valid keys while preserving the probe order.

Complexity

• O(N) worst-case when all slots are occupied.

Trait Implementations

impl<K: Clone + Copy, V: Clone, const N: usize> Clone for ExampleStaticMapU16<K, V, N>

fn clone(&self) -> ExampleStaticMapU16<K, V, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Copy, V: Debug, const N: usize> Debug for ExampleStaticMapU16<K, V, N>

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

Formats the value using the given formatter.

impl<V: Default, const N: usize> Default for ExampleStaticMapU16<u16, V, N>

fn default() -> Self

Creates an empty hashmap.

Panics

Panics in debug if EMPTY and TOMB are equal, or if any of them are out of range for $KEY.

impl<K: Hash + Copy, V: Hash, const N: usize> Hash for ExampleStaticMapU16<K, V, N>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<K: PartialEq + Copy, V: PartialEq, const N: usize> PartialEq for ExampleStaticMapU16<K, V, N>

fn eq(&self, other: &ExampleStaticMapU16<K, V, 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<K: Copy + Copy, V: Copy, const N: usize> Copy for ExampleStaticMapU16<K, V, N>

impl<K: Eq + Copy, V: Eq, const N: usize> Eq for ExampleStaticMapU16<K, V, N>

impl<K: Copy, V, const N: usize> StructuralPartialEq for ExampleStaticMapU16<K, V, N>