Trait linera_views::store::ReadableKeyValueStore

pub trait ReadableKeyValueStore: WithError + Send {
    type Keys: KeyIterable<Self::Error>;
    type KeyValues: KeyValueIterable<Self::Error>;

    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;
    fn contains_key(
        &self,
        key: &[u8],
    ) -> impl Future<Output = Result<bool, Self::Error>> + Send;
    fn contains_keys(
        &self,
        keys: Vec<Vec<u8>>,
    ) -> impl Future<Output = Result<Vec<bool>, Self::Error>> + Send;
    fn read_multi_values_bytes(
        &self,
        keys: Vec<Vec<u8>>,
    ) -> impl Future<Output = Result<Vec<Option<Vec<u8>>>, Self::Error>> + Send;
    fn find_keys_by_prefix(
        &self,
        key_prefix: &[u8],
    ) -> impl Future<Output = Result<Self::Keys, Self::Error>> + Send;
    fn find_key_values_by_prefix(
        &self,
        key_prefix: &[u8],
    ) -> impl Future<Output = Result<Self::KeyValues, Self::Error>> + Send;

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

Low-level, asynchronous read key-value operations. Useful for storage APIs not based on views.

Required Associated Types

type Keys: KeyIterable<Self::Error>

Returns type for key search operations.

type KeyValues: KeyValueIterable<Self::Error>

Returns type for key-value search 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

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

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

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

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

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

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<Self::KeyValues, Self::Error>> + Send

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

where Self: Sync,

Reads a single key and deserializes the result if present.

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

where Self: Sync,

Reads multiple keys and deserializes the results if present.

Object Safety

This trait is not object safe.

Implementors

impl ReadableKeyValueStore for DynamoDbStoreInternal

const MAX_KEY_SIZE: usize = 1_024usize

type Keys = DynamoDbKeys

type KeyValues = DynamoDbKeyValues

impl ReadableKeyValueStore for MemoryStore

const MAX_KEY_SIZE: usize = 18_446_744_073_709_551_615usize

type Keys = Vec<Vec<u8>>

type KeyValues = Vec<(Vec<u8>, Vec<u8>)>

impl ReadableKeyValueStore for RocksDbStoreInternal

const MAX_KEY_SIZE: usize = 8_388_208usize

type Keys = Vec<Vec<u8>>

type KeyValues = Vec<(Vec<u8>, Vec<u8>)>

impl ReadableKeyValueStore for ScyllaDbStoreInternal

const MAX_KEY_SIZE: usize = 10_240usize

type Keys = Vec<Vec<u8>>

type KeyValues = Vec<(Vec<u8>, Vec<u8>)>

impl ReadableKeyValueStore for LimitedTestMemoryStore

const MAX_KEY_SIZE: usize = 18_446_744_073_709_551_615usize

type Keys = Vec<Vec<u8>>

type KeyValues = Vec<(Vec<u8>, Vec<u8>)>

impl<C> ReadableKeyValueStore for ViewContainer<C>

where C: Context + Sync + Send + Clone, ViewError: From<C::Error>,

const MAX_KEY_SIZE: usize = C::MAX_KEY_SIZE

type Keys = Vec<Vec<u8>>

type KeyValues = Vec<(Vec<u8>, Vec<u8>)>

impl<K> ReadableKeyValueStore for JournalingKeyValueStore<K>

where K: ReadableKeyValueStore + Send + Sync, K::Error: From<JournalConsistencyError>,

const MAX_KEY_SIZE: usize = K::MAX_KEY_SIZE

type Keys = <K as ReadableKeyValueStore>::Keys

type KeyValues = <K as ReadableKeyValueStore>::KeyValues

impl<K> ReadableKeyValueStore for LruCachingStore<K>

where K: ReadableKeyValueStore + Send + Sync,

const MAX_KEY_SIZE: usize = K::MAX_KEY_SIZE

type Keys = <K as ReadableKeyValueStore>::Keys

type KeyValues = <K as ReadableKeyValueStore>::KeyValues

impl<K> ReadableKeyValueStore for MeteredStore<K>

where K: ReadableKeyValueStore + Send + Sync,

const MAX_KEY_SIZE: usize = K::MAX_KEY_SIZE

type Keys = <K as ReadableKeyValueStore>::Keys

type KeyValues = <K as ReadableKeyValueStore>::KeyValues

impl<K> ReadableKeyValueStore for ValueSplittingStore<K>

where K: ReadableKeyValueStore + Send + Sync, K::Error: 'static,

const MAX_KEY_SIZE: usize = _

type Keys = Vec<Vec<u8>>

type KeyValues = Vec<(Vec<u8>, Vec<u8>)>

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

where S1: ReadableKeyValueStore + Send + Sync, S2: ReadableKeyValueStore + Send + Sync, A: Send + Sync,

const MAX_KEY_SIZE: usize = _

type Keys = DualStoreKeys<<S1 as ReadableKeyValueStore>::Keys, <S2 as ReadableKeyValueStore>::Keys>

type KeyValues = DualStoreKeyValues<<S1 as ReadableKeyValueStore>::KeyValues, <S2 as ReadableKeyValueStore>::KeyValues>