Struct InlineHashMap 

pub struct InlineHashMap<K, V, const N: usize>(/* private fields */);

Similar to InlineVec, this structure will use an array if it is small enough to live on the stack, otherwise it allocates a HashMap on the heap

Hashing can be slower than just iterating through an array if the array is small, which is where it makes most sense

Implementations

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

where K: Hash + Eq,

pub fn len(&self) -> usize

Returns the number of elements in the map

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements

pub fn iter(&self) -> Iter<'_, K, V>

Returns an iterator over the elements of this map

This can iterate over either stack-backed entries or, in std builds, heap-backed entries.

pub unsafe fn inline_parts_mut( &mut self, ) -> Option<(&mut [MaybeUninit<(K, V)>; N], usize)>

If self is inlined, this returns the underlying raw parts that make up this InlineHashMap.

Only the first .1 elements are initialized.

fn mutate<K: core::hash::Hash + Eq, V, const N: usize>(values: &mut tl::inline::hashmap::InlineHashMap<K, V, N>) {
    let _ = values.inline_parts_mut(); // an unsafe call is required
}

Safety

Before the borrow ends, the initialized prefix must contain valid, uniquely owned values of the element type. Replacing a slot with uninitialized data, duplicating an owner or dropping it without replacing it violates this contract. Prefer get_mut or typed mutable access instead.

pub fn is_heap_allocated(&self) -> bool

Checks whether this vector is allocated on the heap

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

Inserts a new element into the map

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

Removes an element from the map, and returns ownership over the value

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

Returns a reference to the value corresponding to the key.

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

Returns a mutable reference to the value corresponding to the key.

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

Checks whether the map contains a value for the specified key.

Trait Implementations

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

fn clone(&self) -> Self

Returns a duplicate 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 InlineHashMap<K, V, N>

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

Formats the value using the given formatter.