Struct scrypto::component::kv_store::KeyValueStore

pub struct KeyValueStore<K: ScryptoEncode + ScryptoDecode + ScryptoDescribe, V: ScryptoEncode + ScryptoDecode + ScryptoDescribe> {
    pub id: Own,
    pub key: PhantomData<K>,
    pub value: PhantomData<V>,
}

A scalable key-value map which loads entries on demand.

Fields

id: Own

key: PhantomData<K>

value: PhantomData<V>

Implementations

impl<K: ScryptoEncode + ScryptoDecode + ScryptoDescribe, V: ScryptoEncode + ScryptoDecode + ScryptoDescribe> KeyValueStore<K, V>

pub fn new() -> Self

Creates a new key value store.

pub fn get(&self, key: &K) -> Option<KeyValueEntryRef<'_, V>>

Returns the value that is associated with the given key.

pub fn get_mut(&mut self, key: &K) -> Option<KeyValueEntryRefMut<'_, V>>

pub fn insert(&self, key: K, value: V)

Inserts a new key-value pair into this map.

pub fn remove(&self, key: &K) -> Option<V>

Remove an entry from the map and return the original value if it exists

Trait Implementations

impl<K: ScryptoEncode + ScryptoDecode + ScryptoDescribe, V: ScryptoEncode + ScryptoDecode + ScryptoDescribe> Categorize<ScryptoCustomValueKind> for KeyValueStore<K, V>

fn value_kind() -> ValueKind<ScryptoCustomValueKind>

impl<K: ScryptoEncode + ScryptoDecode + ScryptoDescribe, V: ScryptoEncode + ScryptoDecode + ScryptoDescribe, D: Decoder<ScryptoCustomValueKind>> Decode<ScryptoCustomValueKind, D> for KeyValueStore<K, V>

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<ScryptoCustomValueKind> ) -> Result<Self, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind.

impl<K: ScryptoEncode + ScryptoDecode + ScryptoDescribe, V: ScryptoEncode + ScryptoDecode + ScryptoDescribe> Describe<ScryptoCustomTypeKind> for KeyValueStore<K, V>

const TYPE_ID: RustTypeId = _

The TYPE_ID should give a unique identifier for its SBOR schema type. An SBOR schema type capture details about the SBOR payload, how it should be interpreted, validated and displayed.

fn type_data() -> TypeData<ScryptoCustomTypeKind, RustTypeId>

Returns the local schema for the given type.

fn add_all_dependencies(aggregator: &mut TypeAggregator<C>)

For each type referenced in get_local_type_data, we need to ensure that the type and all of its own references get added to the aggregator.

impl<K: ScryptoEncode + ScryptoDecode + ScryptoDescribe, V: ScryptoEncode + ScryptoDecode + ScryptoDescribe, E: Encoder<ScryptoCustomValueKind>> Encode<ScryptoCustomValueKind, E> for KeyValueStore<K, V>

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder.