Struct StableBTreeMap 

pub struct StableBTreeMap<K: Storable + Ord + Clone, V: Storable, M: Memory = DefaultMemoryImpl> { /* private fields */ }

StableBTreeMap

ICSS-baseline ordered map owning one governed allocation. Stored codec and engine failures trap. Native callers must discard the runtime after a mutation panic.

Implementations

impl<K: Storable + Ord + Clone, V: Storable, M: Memory> StableBTreeMap<K, V, M>

pub fn create(memory: RuntimeMemory<M>) -> Result<Self, CollectionError>

Create only in empty admitted memory.

Errors

Refuses nonempty memory or initial growth refusal.

pub fn reset(memory: RuntimeMemory<M>) -> Result<Self, CollectionError>

Explicitly replace this allocation’s collection image.

Errors

Refuses initial growth before creating the map.

pub fn load(memory: RuntimeMemory<M>) -> Result<Self, CollectionError>

Load the current BTR version without initialization or migration.

Errors

Refuses empty or foreign framing.

pub fn clear(&mut self) -> Result<(), CollectionError>

Clear entries and reuse the map’s existing backing capacity.

Errors

Engine failures trap instead of returning an ordinary error.

pub const fn set_node_cache_budget(&mut self, _bytes: usize)

Bound routing-cache memory. The baseline engine caches no routing nodes, so every supplied ceiling is satisfied with zero cached bytes.

pub fn reserve_pages(self, minimum: u64) -> (Self, Result<(), RuntimeGrowError>)

Reserve backing pages without promising entry capacity.

pub fn allocated_pages(self) -> (Self, u64)

Observe allocated pages while retaining exclusive custody.

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

Insert or replace. Invalid codecs and allocation failures trap.

Errors

Engine failures trap instead of returning an ordinary error.

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

Read a matching value; malformed stored values trap.

Errors

Engine failures trap instead of returning an ordinary error.

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

Test key membership without decoding values.

Errors

Engine failures trap instead of returning an ordinary error.

pub const fn is_empty(&self) -> bool

Whether no entries are committed.

pub const fn len(&self) -> u64

Number of entries.

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

Remove a matching value; codec and engine failures trap.

Errors

Engine failures trap instead of returning an ordinary error.

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

First ordered key/value pair.

Errors

Engine failures trap instead of returning an ordinary error.

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

Last ordered key/value pair.

Errors

Engine failures trap instead of returning an ordinary error.

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

Iterate in key order.

pub fn range(&self, bounds: impl RangeBounds<K>) -> MapIter<'_, K, V, M>

Iterate a bounded key range.

pub fn keys( &self, ) -> impl DoubleEndedIterator<Item = Result<K, CollectionError>> + '_

Iterate keys without reading value payloads.

pub fn keys_range( &self, bounds: impl RangeBounds<K>, ) -> impl DoubleEndedIterator<Item = Result<K, CollectionError>> + '_

Iterate bounded keys without reading value payloads.

pub fn values( &self, ) -> impl DoubleEndedIterator<Item = Result<V, CollectionError>> + '_

Iterate decoded values.

Trait Implementations

impl<'a, K: Storable + Ord + Clone, V: Storable, M: Memory> IntoIterator for &'a StableBTreeMap<K, V, M>

type Item = <MapIter<'a, K, V, M> as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = MapIter<'a, K, V, M>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.