radix-engine-interface 1.3.1

The interface between system layer and VM layer, from the Radix DLT project.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

use radix_common::data::scrypto::{scrypto_decode, scrypto_encode, ScryptoDecode, ScryptoEncode};
use sbor::rust::prelude::*;

pub type KeyValueEntryHandle = u32;

pub trait SystemKeyValueEntryApi<E> {
    /// Reads the value of a key value entry
    fn key_value_entry_get(&mut self, handle: KeyValueEntryHandle) -> Result<Vec<u8>, E>;

    /// Reads the value of a key value entry and decodes it into a specific type
    fn key_value_entry_get_typed<S: ScryptoDecode>(
        &mut self,
        handle: KeyValueEntryHandle,
    ) -> Result<Option<S>, E> {
        let buffer = self.key_value_entry_get(handle)?;
        let value: Option<S> = scrypto_decode(&buffer).unwrap();
        Ok(value)
    }

    /// Set the value of a key value entry
    fn key_value_entry_set(
        &mut self,
        handle: KeyValueEntryHandle,
        buffer: Vec<u8>,
    ) -> Result<(), E>;

    /// Set the value of a key value entry
    fn key_value_entry_set_typed<S: ScryptoEncode>(
        &mut self,
        handle: KeyValueEntryHandle,
        value: S,
    ) -> Result<(), E> {
        let buffer = scrypto_encode(&value).unwrap();
        self.key_value_entry_set(handle, buffer)
    }

    /// Remove the value of a key value entry
    fn key_value_entry_remove(&mut self, handle: KeyValueEntryHandle) -> Result<Vec<u8>, E>;

    /// Lock the value of a key value entry making the value immutable
    fn key_value_entry_lock(&mut self, handle: KeyValueEntryHandle) -> Result<(), E>;

    /// Close the handle into the key value entry rendering it unusable after close
    fn key_value_entry_close(&mut self, handle: KeyValueEntryHandle) -> Result<(), E>;
}