Struct Database

pub struct Database { /* private fields */ }

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 Database

pub async fn new(mode: StartMode) -> Result<Self, Error>

Create a new database instance with default parameters

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

Create a new database instance with specific parameters

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

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

pub async fn delete(&self, key: Key) -> Result<(), Error>

Delete an existing entry For efficiency, the datastore does not check whether the key actually existed Instead, it will just mark the most recent version (which could be the first one) as deleted

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

Ensure all data is written to disk Only has an effect if there were previous writes with sync=false

pub async fn delete_opts( &self, key: Key, opts: &WriteOptions, ) -> Result<(), Error>

Delete an existing entry (with additional options)

pub async fn put(&self, key: Key, value: Value) -> Result<(), Error>

Insert or update a single entry

pub async fn put_opts( &self, key: Key, value: Value, opts: &WriteOptions, ) -> Result<(), Error>

Insert or update a single entry (with additional options)

pub async fn iter(&self) -> DbIterator

Iterate over all entries in the database

pub async fn range_iter(&self, min_key: &[u8], max_key: &[u8]) -> DbIterator

Like iter(), but will only include entries with keys in [min_key;max_key)

pub async fn reverse_range_iter( &self, max_key: &[u8], min_key: &[u8], ) -> DbIterator

Like range_iter(), but in reverse. It will only include entries with keys in (min_key;max_key]

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

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, opts: &WriteOptions, ) -> Result<(), Error>

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

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

Stop all background tasks gracefully

Trait Implementations

impl Drop for Database

fn drop(&mut self)

Executes the destructor for this type.