Struct PackedMap

Source

pub struct PackedMap<K: ?Sized + Ord + PackedItem, V> { /* private fields */ }

Expand description

A map with keys stored in a sorted PackedVec<K> and values in a Vec<V>.

This map is optimized for reducing memory usage by using a packed representation for keys. It does not support modification after creation.

Implementations§

Source §

impl<K, V> PackedMap<K, V>
where K: ?Sized + Ord + PackedItem,

Source

pub fn builder() -> PackedMapBuilder<K, V>
where K: ToOwned, K::Owned: Ord,

Creates a new PackedMapBuilder.

Source

pub fn builder_with_capacity( element_capacity: usize, buffer_capacity: usize, ) -> PackedMapBuilder<K, V>
where K: ToOwned, K::Owned: Ord,

Creates a new PackedMapBuilder with the specified capacities.

The element_capacity argument specifies the number of slices that can be stored without reallocating the offsets vector. The buffer_capacity argument specifies the cumulative length of slices that can be stored without reallocating the data vector.

Source

pub fn new() -> Self

Creates a new empty PackedMap.

Source

pub fn with_capacity(element_capacity: usize, buffer_capacity: usize) -> Self

Creates a new PackedMap with the specified capacities.

The element_capacity argument specifies the number of slices that can be stored without reallocating the offsets vector. The buffer_capacity argument specifies the cumulative length of slices that can be stored without reallocating the data vector.

Source

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

Source

pub fn element_len(&self) -> usize

Returns the number of elements in the map.

Source

pub fn buffer_len(&self) -> usize

Returns the cumulative length of all keys in the map in bytes.

Source

pub fn get<Q>(&self, key: &Q) -> Option<&V>
where K: Borrow<Q>, Q: Ord + ?Sized,

Returns a reference to the value corresponding to the key.

Source

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>
where K: Borrow<Q>, Q: Ord + ?Sized,

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

Source

pub fn contains_key<Q>(&self, key: &Q) -> bool
where K: Borrow<Q>, Q: Ord + ?Sized,

Returns true if the map contains a value for the specified key.

Source

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

Inserts a key-value pair into the map.

If the key is already present, updates the value and returns Ok(Some(old_value)). If the key is greater than the last key, appends it and returns Ok(None). Otherwise, returns Err(value).

§Complexity

O(1) if the key is greater than or equal to the last key in the map.
O(log N) otherwise, where N is the number of elements in the map.

Source

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the map as much as possible.

Source

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

Returns an iterator over the entries of the map, sorted by key.

Source

pub fn iter_mut(&mut self) -> IterMut<'_, K, V>

Returns an iterator over the entries of the map, sorted by key, with mutable values.

Source

pub fn drain(&mut self) -> Drain<'_, K, V>

Drains all elements from the map, returning a lending iterator that yields them.

The elements are yielded in sorted order by key. After the iterator is dropped, the map is left empty.

§Leaked

If the returned Drain iterator is leaked (e.g. via std::mem::forget), any elements that have not been yielded yet will be leaked (their destructors will not run). However, memory safety is still preserved as the map will be left empty.

Source