Struct linera_views::context::ViewContext

pub struct ViewContext<E, S> { /* private fields */ }

Implementation of the Context trait on top of a DB client implementing crate::store::KeyValueStore.

Implementations

impl<E, S> ViewContext<E, S>

where S: RestrictedKeyValueStore,

pub async fn create_root_context(store: S, extra: E) -> Result<Self, S::Error>

Creates a context suitable for a root view, using the given store. If the journal’s store is non-empty, it will be cleared first, before the context is returned.

impl<E, S> ViewContext<E, S>

pub fn new_unsafe(store: S, base_key: Vec<u8>, extra: E) -> Self

Creates a context for the given base key, store, and an extra argument. NOTE: this constructor doesn’t check the journal of the store. In doubt, use ViewContext::create_root_context instead.

impl<E> ViewContext<E, MemoryStore>

pub fn new_for_testing( max_stream_queries: usize, namespace: &str, root_key: &[u8], extra: E, ) -> Self

Creates a Context instance in memory for testing.

Trait Implementations

impl<E: Clone, S: Clone> Clone for ViewContext<E, S>

fn clone(&self) -> ViewContext<E, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E, S> Context for ViewContext<E, S>

where E: Clone + Send + Sync, S: RestrictedKeyValueStore + Clone + Send + Sync, S::Error: From<Error> + Send + Sync + Error + 'static,

const MAX_VALUE_SIZE: usize = S::MAX_VALUE_SIZE

The maximal size of values that can be stored.

const MAX_KEY_SIZE: usize = S::MAX_KEY_SIZE

The maximal size of keys that can be stored.

type Extra = E

User-provided data to be carried along.

type Error = <S as WithError>::Error

The error type in use by internal operations.

type Keys = <S as ReadableKeyValueStore>::Keys

Returns type for key search operations.

type KeyValues = <S as ReadableKeyValueStore>::KeyValues

Returns type for key-value search operations.

fn max_stream_queries(&self) -> usize

Retrieves the number of stream queries.

fn extra(&self) -> &E

Getter for the user-provided data.

fn base_key(&self) -> Vec<u8>

Getter for the address of the base key.

fn read_value_bytes<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieves a Vec<u8> from the database using the provided key prefixed by the current context.

fn contains_key<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<bool, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Tests whether a key exists in the database

fn contains_keys<'life0, 'async_trait>( &'life0 self, keys: Vec<Vec<u8>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<bool>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Tests whether a set of keys exist in the database

fn read_multi_values_bytes<'life0, 'async_trait>( &'life0 self, keys: Vec<Vec<u8>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Option<Vec<u8>>>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn find_keys_by_prefix<'life0, 'life1, 'async_trait>( &'life0 self, key_prefix: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<Self::Keys, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Finds the keys matching the key_prefix. The key_prefix is not included in the returned keys.

fn find_key_values_by_prefix<'life0, 'life1, 'async_trait>( &'life0 self, key_prefix: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<Self::KeyValues, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

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

fn write_batch<'life0, 'async_trait>( &'life0 self, batch: Batch, ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Applies the operations from the batch, persisting the changes.

fn clone_with_base_key(&self, base_key: Vec<u8>) -> Self

Obtains a similar Context implementation with a different base key.

fn base_tag(&self, tag: u8) -> Vec<u8>

Concatenates the base key and tag.

fn base_tag_index(&self, tag: u8, index: &[u8]) -> Vec<u8>

Concatenates the base key, tag and index.

fn base_index(&self, index: &[u8]) -> Vec<u8>

Concatenates the base key and index.

fn derive_key<I: Serialize>(&self, index: &I) -> Result<Vec<u8>, Self::Error>

Obtains the Vec<u8> key from the key by serialization and using the base key.

fn derive_tag_key<I: Serialize>( &self, tag: u8, index: &I, ) -> Result<Vec<u8>, Self::Error>

Obtains the Vec<u8> key from the key by serialization and using the base_key.

fn derive_short_key<I: Serialize + ?Sized>( index: &I, ) -> Result<Vec<u8>, Self::Error>

Obtains the short Vec<u8> key from the key by serialization.

fn deserialize_value<Item: DeserializeOwned>( bytes: &[u8], ) -> Result<Item, Self::Error>

Deserialize bytes into type Item.

fn read_value<'life0, 'life1, 'async_trait, Item>( &'life0 self, key: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<Option<Item>, Self::Error>> + Send + 'async_trait>>

where Item: DeserializeOwned + 'async_trait, Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieves a generic Item from the database using the provided key prefixed by the current context. The Item is deserialized using bcs.

impl<E: Debug, S: Debug> Debug for ViewContext<E, S>

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

Formats the value using the given formatter.

impl<E: Default, S: Default> Default for ViewContext<E, S>

fn default() -> ViewContext<E, S>

Returns the “default value” for a type.