Struct tinkv::Store

pub struct Store { /* fields omitted */ }

The Store stores key/value pairs.

Key/value pairs are persisted in data files.

Implementations

impl Store

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Initialize key value store with the given path. If the given path not found, a new one will be created.

pub fn set(&mut self, key: &[u8], value: &[u8]) -> Result<()>

Save key & value pair to database.

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

Remove key value from database.

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

Get key value from database.

pub fn compact(&mut self) -> Result<()>

Clear stale entries from data files and reclaim disk space.

pub fn stats(&self) -> &Stats

Return current stats of datastore.

pub fn keys(&self) -> impl Iterator<Item = &Vec<u8>>

Return all keys in datastore.

pub fn len(&self) -> u64

Return total number of keys in datastore.

pub fn is_empty(&self) -> bool

Check datastore is empty or not.

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

Return true if datastore contains the given key.

pub fn for_each<F>(&mut self, f: &mut F) -> Result<()> where
    F: FnMut(&[u8], &[u8]) -> Result<bool>, 

Iterate all keys in datastore and call function f for each entry.

If function f returns an Err, it stops iteration and propgates the Err to the caller.

You can continue iteration manually by returning Ok(true), or stop iteration by returning Ok(false).

pub fn sync(&mut self) -> Result<()>

Force flushing any pending writes to disk.

pub fn close(&mut self) -> Result<()>

Close a tinkv data store, flush all pending writes to disk.

Trait Implementations

impl Debug for Store

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Drop for Store

fn drop(&mut self)

Executes the destructor for this type.