Struct soroban_sdk::storage::Instance

pub struct Instance { /* private fields */ }

Implementations

impl Instance

pub fn has<K>(&self, key: &K) -> bool

where K: IntoVal<Env, Val>,

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

where V::Error: Debug, K: IntoVal<Env, Val>, V: TryFromVal<Env, Val>,

pub fn set<K, V>(&self, key: &K, val: &V)

where K: IntoVal<Env, Val>, V: IntoVal<Env, Val>,

pub fn update<K, V>(&self, key: &K, f: impl FnOnce(Option<V>) -> V) -> V

where K: IntoVal<Env, Val>, V: IntoVal<Env, Val> + TryFromVal<Env, Val>,

Update a value stored against a key.

Loads the value, calls the function with it, then sets the value to the returned value of the function. If no value is stored with the key then the function is called with None.

The returned value is the value stored after updating.

pub fn try_update<K, V, E>( &self, key: &K, f: impl FnOnce(Option<V>) -> Result<V, E> ) -> Result<V, E>

where K: IntoVal<Env, Val>, V: IntoVal<Env, Val> + TryFromVal<Env, Val>,

Update a value stored against a key.

Loads the value, calls the function with it, then sets the value to the returned value of the function. If no value is stored with the key then the function is called with None. If the function returns an error it will be passed through.

The returned value is the value stored after updating.

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

where K: IntoVal<Env, Val>,

pub fn extend_ttl(&self, threshold: u32, extend_to: u32)

Extend the TTL of the contract instance and code.

Extends the TTL of the instance and code only if the TTL for the provided contract is below threshold ledgers. The TTL will then become extend_to. Note that the threshold check and TTL extensions are done for both the contract code and contract instance, so it’s possible that one is bumped but not the other depending on what the current TTL’s are.

The TTL is the number of ledgers between the current ledger and the final ledger the data can still be accessed.

Trait Implementations

impl Instance for Instance

Available on crate feature testutils only.

fn all(&self) -> Map<Val, Val>

Returns all data stored in Instance storage for the contract.