Trait ReadableKeyValueStore

pub trait ReadableKeyValueStore:
    WithError
    + Send
    + Sync {
    const MAX_KEY_SIZE: usize;

    // Required methods
    fn max_stream_queries(&self) -> usize;
    fn read_value_bytes(
        &self,
        key: &[u8],
    ) -> impl Future<Output = Result<Option<Vec<u8>>, Self::Error>> + Send + Sync;
    fn contains_key(
        &self,
        key: &[u8],
    ) -> impl Future<Output = Result<bool, Self::Error>> + Send + Sync;
    fn contains_keys(
        &self,
        keys: Vec<Vec<u8>>,
    ) -> impl Future<Output = Result<Vec<bool>, Self::Error>> + Send + Sync;
    fn read_multi_values_bytes(
        &self,
        keys: Vec<Vec<u8>>,
    ) -> impl Future<Output = Result<Vec<Option<Vec<u8>>>, Self::Error>> + Send + Sync;
    fn find_keys_by_prefix(
        &self,
        key_prefix: &[u8],
    ) -> impl Future<Output = Result<Vec<Vec<u8>>, Self::Error>> + Send + Sync;
    fn find_key_values_by_prefix(
        &self,
        key_prefix: &[u8],
    ) -> impl Future<Output = Result<Vec<(Vec<u8>, Vec<u8>)>, Self::Error>> + Send + Sync;

    // Provided methods
    fn read_value<V: DeserializeOwned>(
        &self,
        key: &[u8],
    ) -> impl Future<Output = Result<Option<V>, Self::Error>> + Send + Sync { ... }
    fn read_multi_values<V: DeserializeOwned + Send + Sync>(
        &self,
        keys: Vec<Vec<u8>>,
    ) -> impl Future<Output = Result<Vec<Option<V>>, Self::Error>> + Send + Sync { ... }
}

Asynchronous read key-value operations.

Required Associated Constants

const MAX_KEY_SIZE: usize

The maximal size of keys that can be stored.

Required Methods

fn max_stream_queries(&self) -> usize

Retrieve the number of stream queries.

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

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

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

Tests whether a key exists in the database

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

Tests whether a list of keys exist in the database

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

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

fn find_keys_by_prefix( &self, key_prefix: &[u8], ) -> impl Future<Output = Result<Vec<Vec<u8>>, Self::Error>> + Send + Sync

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

fn find_key_values_by_prefix( &self, key_prefix: &[u8], ) -> impl Future<Output = Result<Vec<(Vec<u8>, Vec<u8>)>, Self::Error>> + Send + Sync

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

Provided Methods

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

Reads a single key and deserializes the result if present.

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

Reads multiple keys and deserializes the results if present.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl ReadableKeyValueStore for DynamoDbStoreInternal

const MAX_KEY_SIZE: usize = 1_024usize

impl ReadableKeyValueStore for MemoryStore

const MAX_KEY_SIZE: usize = 18_446_744_073_709_551_615usize

impl ReadableKeyValueStore for RocksDbStoreInternal

const MAX_KEY_SIZE: usize = 8_388_208usize

impl ReadableKeyValueStore for ScyllaDbStoreInternal

const MAX_KEY_SIZE: usize = 10_240usize

impl ReadableKeyValueStore for LimitedTestMemoryStore

const MAX_KEY_SIZE: usize = 18_446_744_073_709_551_615usize

impl ReadableKeyValueStore for InactiveStore

const MAX_KEY_SIZE: usize = 0usize

impl<C: Context> ReadableKeyValueStore for ViewContainer<C>

const MAX_KEY_SIZE: usize = <C::Store as ReadableKeyValueStore>::MAX_KEY_SIZE

impl<K> ReadableKeyValueStore for LruCachingStore<K>

where K: ReadableKeyValueStore,

const MAX_KEY_SIZE: usize = K::MAX_KEY_SIZE

impl<S1, S2> ReadableKeyValueStore for DualStore<S1, S2>

where S1: ReadableKeyValueStore, S2: ReadableKeyValueStore,

const MAX_KEY_SIZE: usize

impl<S> ReadableKeyValueStore for JournalingKeyValueStore<S>

where S: ReadableKeyValueStore, S::Error: From<JournalConsistencyError>,

const MAX_KEY_SIZE: usize = S::MAX_KEY_SIZE

impl<S> ReadableKeyValueStore for MeteredStore<S>

where S: ReadableKeyValueStore,

const MAX_KEY_SIZE: usize = S::MAX_KEY_SIZE

impl<S> ReadableKeyValueStore for ValueSplittingStore<S>

where S: ReadableKeyValueStore, S::Error: 'static,

const MAX_KEY_SIZE: usize