Struct BudgetedMap 

pub struct BudgetedMap<K, V> { /* private fields */ }

An ordered map with logarithmic lookup, insertion and removal. Each node reserves its entire allocation before construction; keys and values retain their own separately allocated payloads. Removing a node frees its allocation before releasing that reservation. The map never clones elements or retains unused nodes.

Implementations

impl<K, V> BudgetedMap<K, V>

pub fn new(memory: &MemoryBudget) -> Self

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn budget(&self) -> &MemoryBudget

pub fn prepare_entry( &self, key: K, value: V, ) -> Result<PreparedMapEntry<K, V>, MemoryError>

pub fn for_each_mut(&mut self, visit: impl FnMut(&K, &mut V))

Visit mutable values in key order without allocating a traversal buffer or allowing keys to change.

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

impl<K: Ord, V> BudgetedMap<K, V>

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

where K: Borrow<Q>,

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

where K: Borrow<Q>,

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

where K: Borrow<Q>,

pub fn insert_prepared(&mut self, entry: PreparedMapEntry<K, V>) -> Option<V>

Publish an already reserved entry without allocation. A matching key retains its original key and returns the replaced value. Panics before mutation if the entry belongs to a different allowance.

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

Reserve a node only for a new key. Failure preserves the map, its entries and its reservations.

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

where K: Borrow<Q>,

Trait Implementations

impl<K: Ord + Borrow<Q>, V, Q: Ord + ?Sized> Index<&Q> for BudgetedMap<K, V>

type Output = V

The returned type after indexing.

fn index(&self, key: &Q) -> &V

Performs the indexing (container[index]) operation.

impl<'a, K, V> IntoIterator for &'a BudgetedMap<K, V>

type Item = (&'a K, &'a V)

The type of the elements being iterated over.

type IntoIter = BudgetedMapIter<'a, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.