Trait oasis_core_runtime::storage::mkvs::MKVS

pub trait MKVS {
    // Required methods
    fn get(&self, key: &[u8]) -> Option<Vec<u8>>;
    fn get_proof(&self, key: &[u8]) -> Option<Proof>;
    fn cache_contains_key(&self, key: &[u8]) -> bool;
    fn insert(&mut self, key: &[u8], value: &[u8]) -> Option<Vec<u8>>;
    fn remove(&mut self, key: &[u8]) -> Option<Vec<u8>>;
    fn prefetch_prefixes(&self, prefixes: &[Prefix], limit: u16);
    fn iter(&self) -> Box<dyn Iterator + '_>;
    fn commit(
        &mut self,
        namespace: Namespace,
        version: u64,
    ) -> Result<(WriteLog, Hash)>;
}

Merklized key-value store.

Required Methods

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

Fetch entry with given key.

fn get_proof(&self, key: &[u8]) -> Option<Proof>

Fetch proof for entry with given key.

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

Check if the local MKVS cache contains the given key.

While get can be used to check if the MKVS as a whole contains a given key, this function specifically guarantees that no remote syncing will be invoked, only checking the local cache.

fn insert(&mut self, key: &[u8], value: &[u8]) -> Option<Vec<u8>>

Update entry with given key.

If the database did not have this key present, None is returned.

If the database did have this key present, the value is updated, and the old value is returned.

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

Remove entry with given key, returning the value at the key if the key was previously in the database.

fn prefetch_prefixes(&self, prefixes: &[Prefix], limit: u16)

Populate the in-memory tree with nodes for keys starting with given prefixes.

fn iter(&self) -> Box<dyn Iterator + '_>

Returns an iterator over the tree.

fn commit( &mut self, namespace: Namespace, version: u64, ) -> Result<(WriteLog, Hash)>

Commit all database changes to the underlying store.

Implementations on Foreign Types

impl<T: MKVS + ?Sized> MKVS for &mut T

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

fn get_proof(&self, key: &[u8]) -> Option<Proof>

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

fn insert(&mut self, key: &[u8], value: &[u8]) -> Option<Vec<u8>>

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

fn prefetch_prefixes(&self, prefixes: &[Prefix], limit: u16)

fn iter(&self) -> Box<dyn Iterator + '_>

fn commit( &mut self, namespace: Namespace, version: u64, ) -> Result<(WriteLog, Hash)>

Implementors

impl<T: FallibleMKVS> MKVS for OverlayTree<T>