Struct BTreeMap 

pub struct BTreeMap<M: Memory = DefaultMemoryImpl, C: Comparator = Lexicographic> { /* private fields */ }

Our page-based tree consuming a governed allocation handle. No raw memory access or extraction is exposed; drop before reopening.

Implementations

impl<M: Memory, C: Comparator> BTreeMap<M, C>

pub fn create( memory: RuntimeMemory<M>, config: Config, order: C, ) -> Result<Self, Error>

Create the custom format with the exact configuration and comparator.

Errors

Returns the engine’s format, configuration, corruption or capacity error.

pub fn open( memory: RuntimeMemory<M>, config: Config, order: C, ) -> Result<Self, Error>

Open the custom format with the exact configuration and comparator.

Errors

Returns the engine’s format, configuration, corruption or capacity error.

pub fn len(&self) -> u64

Number of persisted live entries.

pub fn is_empty(&self) -> bool

Whether there are no live entries.

pub fn memory_bytes(&self) -> u64

Bytes reserved, including reusable free pages.

pub fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>, Error>

Read the value for an encoded key.

Errors

Propagates validation, corruption and capacity errors from the engine.

pub fn contains_key(&self, key: &[u8]) -> Result<bool, Error>

Test membership without reading external value payloads.

Errors

Propagates validation, corruption and capacity errors from the engine.

pub fn insert( &mut self, key: &[u8], value: &[u8], ) -> Result<Option<Vec<u8>>, Error>

Insert or replace a value, returning its previous bytes.

Errors

Propagates validation, corruption and capacity errors from the engine.

pub fn remove(&mut self, key: &[u8]) -> Result<Option<Vec<u8>>, Error>

Remove a key, returning its previous value.

Errors

Propagates validation, corruption and capacity errors from the engine.

pub fn range( &self, lower: Bound<&[u8]>, upper: Bound<&[u8]>, ) -> Result<Range<'_, M, C>, Error>

Lazily scan comparator-ordered bounds in either direction.

Errors

Propagates validation, corruption and capacity errors from the engine.

pub fn iter(&self) -> Range<'_, M, C>

Lazily scan all entries in either direction.

pub fn validate(&self) -> Result<(), Error>

Audit reachable pages, ordering, counts and free-list ownership.

Errors

Propagates validation, corruption and capacity errors from the engine.

Trait Implementations

impl<'a, M: Memory, C: Comparator> IntoIterator for &'a BTreeMap<M, C>

type Item = Result<Entry<'a, RuntimeMemory<M>, C>, Error>

The type of the elements being iterated over.

type IntoIter = Range<'a, RuntimeMemory<M>, C>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.