Struct lsm::Database

pub struct Database<K: KV_Trait, V: KV_Trait> { /* fields omitted */ }

The main database structure This struct can be accessed concurrently and you should never instantiate it more than once for the same on-disk files

Implementations

impl<K: 'static + KV_Trait, V: 'static + KV_Trait> Database<K, V>

pub async fn new(mode: StartMode) -> Self

Create a new database instance with default parameters

pub async fn new_with_params(mode: StartMode, params: Params) -> Self

Create a new database instance with specific parameters

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

Will deserialize V from the raw data (avoids an additional copy)

pub async fn put(&self, key: &K, value: &V) -> Result<(), WriteError>

Store

pub async fn put_opts(
    &self,
    key: &K,
    value: &V,
    opts: &WriteOptions
) -> Result<(), WriteError>

pub async fn iter(&self) -> DbIterator<K, V>

pub async fn write(
    &self,
    write_batch: WriteBatch<K, V>
) -> Result<(), WriteError>

Write a batch of updates to the database

If you only want to write to a single key, use Database::put instead

pub async fn write_opts(
    &self,
    write_batch: WriteBatch<K, V>,
    opts: &WriteOptions
) -> Result<(), WriteError>

Write a batch of updates to the database This version of write allows you to specfiy options such as “synchronous”

Trait Implementations

impl<K: KV_Trait, V: KV_Trait> Drop for Database<K, V>

fn drop(&mut self)

Executes the destructor for this type.