Struct KeyValueStore

pub struct KeyValueStore { /* private fields */ }

A type to interface with the key value storage provided to applications.

Implementations

impl KeyValueStore

pub fn mock() -> Self

Returns a new KeyValueStore that just keeps the storage contents in memory.

pub fn to_mut(&self) -> Self

Returns a mocked KeyValueStore that shares the memory storage with this instance but allows write operations.

Trait Implementations

impl Clone for KeyValueStore

fn clone(&self) -> KeyValueStore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ReadableKeyValueStore for KeyValueStore

const MAX_KEY_SIZE: usize = 900usize

The maximal size of keys that can be stored.

fn max_stream_queries(&self) -> usize

Retrieve the number of stream queries.

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

Tests whether a key exists in the database

async fn contains_keys( &self, keys: Vec<Vec<u8>>, ) -> Result<Vec<bool>, KeyValueStoreError>

Tests whether a list of keys exist in the database

async fn read_multi_values_bytes( &self, keys: Vec<Vec<u8>>, ) -> Result<Vec<Option<Vec<u8>>>, KeyValueStoreError>

Retrieves multiple Vec<u8> from the database using the provided keys.

async fn read_value_bytes( &self, key: &[u8], ) -> Result<Option<Vec<u8>>, KeyValueStoreError>

Retrieves a Vec<u8> from the database using the provided key.

async fn find_keys_by_prefix( &self, key_prefix: &[u8], ) -> Result<Vec<Vec<u8>>, KeyValueStoreError>

Finds the key matching the prefix. The prefix is not included in the returned keys.

async fn find_key_values_by_prefix( &self, key_prefix: &[u8], ) -> Result<Vec<(Vec<u8>, Vec<u8>)>, KeyValueStoreError>

Finds the (key,value) pairs matching the prefix. The prefix is not included in the returned keys.

fn read_value<V>( &self, key: &[u8], ) -> impl Future<Output = Result<Option<V>, Self::Error>> + Send + Sync

where V: DeserializeOwned,

Reads a single key and deserializes the result if present.

fn read_multi_values<V>( &self, keys: Vec<Vec<u8>>, ) -> impl Future<Output = Result<Vec<Option<V>>, Self::Error>> + Send + Sync

where V: DeserializeOwned + Send + Sync,

Reads multiple keys and deserializes the results if present.

impl WithError for KeyValueStore

type Error = KeyValueStoreError

The error type.

impl WritableKeyValueStore for KeyValueStore

const MAX_VALUE_SIZE: usize = 18_446_744_073_709_551_615usize

The maximal size of values that can be stored.

async fn write_batch(&self, batch: Batch) -> Result<(), KeyValueStoreError>

Writes the batch in the database.

async fn clear_journal(&self) -> Result<(), KeyValueStoreError>

Clears any journal entry that may remain. The journal is located at the root_key.