Struct boringdb::Dict

pub struct Dict { /* fields omitted */ }

A clonable on-disk mapping, corresponding to a table in SQLite

Implementations

impl Dict

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

Gets a key/value pair.

pub fn insert(
    &self,
    key: impl Into<Bytes>,
    val: impl Into<Bytes>
) -> Result<Option<Bytes>>

Inserts a key/value pair.

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

Delete a key.

pub fn range<'a, K: AsRef<[u8]> + Ord + 'a, R: RangeBounds<K> + 'a>(
    &'a self,
    range: R
) -> Result<impl Iterator<Item = Result<(Bytes, Bytes)>> + 'a>

Iterate through tuples of keys and values, where the keys fall within the specified range.

Note: currently this function returns an iterator that locks the whole dictionary until it is dropped. This will change the future.

pub fn transaction(&self) -> Result<Transaction<'_>>

Runs a transaction. This is NOT optimistic, but rather locking, so care should be taken to avoid long-running transactions.

pub fn flush(&self) -> Result<()>

Flushes to disk. Guarantees that all operations that happens before the call reaches disk before this call terminates.

Note: This can be very slow, especially after a large number of writes. Calling this function is not needed for atomicity or crash-safety, but only when you want to absolutely prevent the database from traveling “back in time” a few seconds in case of a crash. Usually this is only needed if you e.g. want to store a reference to an object in this boringdb database in some other database, and you cannot tolerate “dangling pointers”.

Trait Implementations

impl Clone for Dict

fn clone(&self) -> Dict

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.