Struct MapRef 

pub struct MapRef<'a, K: Key, V> { /* private fields */ }

A convenience handle that bundles a map reference with an epoch guard.

All operations on MapRef are forwarded to the underlying LearnedMap using the guard owned by this handle. This avoids passing a guard to every method call.

Example

use scry_index::LearnedMap;

let map = LearnedMap::new();
let m = map.pin();
m.insert(1u64, "hello");
assert_eq!(m.get(&1), Some(&"hello"));

Implementations

impl<K: Key, V: Clone + Send + Sync> MapRef<'_, K, V>

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

Look up a key, returning a reference to the value if found.

pub fn insert(&self, key: K, value: V) -> bool

Insert a key-value pair. Returns true if the key was newly inserted.

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

Remove a key. Returns true if the key was present and removed.

pub fn get_or_insert(&self, key: K, value: V) -> &V

Atomically get an existing value or insert a new one.

See LearnedMap::get_or_insert for details.

pub fn get_or_insert_with(&self, key: K, f: impl FnOnce() -> V) -> &V

Atomically get an existing value or insert a computed one.

See LearnedMap::get_or_insert_with for details.

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

Check whether the map contains a key.

pub fn len(&self) -> usize

Return the approximate number of key-value pairs in the map.

See LearnedMap::len for details on relaxed-atomic staleness under concurrency.

pub fn is_empty(&self) -> bool

Return true if the map contains no entries.

Subject to the same relaxed-atomic staleness as len.

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

Iterate over all key-value pairs in sorted order.

pub fn iter_sorted(&self) -> Vec<(K, V)>

Collect all key-value pairs in sorted order (cloned).

pub fn range<R: RangeBounds<K>>(&self, range: R) -> Range<'_, K, V>

Return an iterator over key-value pairs within the given range.

pub fn first_key_value(&self) -> Option<(&K, &V)>

Return the first (minimum) key-value pair.

pub fn last_key_value(&self) -> Option<(&K, &V)>

Return the last (maximum) key-value pair.

pub fn range_count<R: RangeBounds<K>>(&self, range: R) -> usize

Count the number of entries within the given range.

pub fn allocated_bytes(&self) -> usize

Estimate the total heap memory allocated by this map, in bytes.

See LearnedMap::allocated_bytes for details.

pub fn max_depth(&self) -> usize

Return the maximum depth of the tree.

pub fn rebuild(&self)

Rebuild the tree from scratch using bulk load.

pub fn drain(&self) -> Vec<(K, V)>

Remove all entries from the map and return them as a sorted Vec.

pub fn clear(&self)

Remove all entries from the map.