Struct soroban_sdk::storage::Storage

pub struct Storage { /* private fields */ }

Storage stores and retrieves data for the currently executing contract.

All data stored can only be queried and modified by the contract that stores it. Contracts cannot query or modify data stored by other contracts.

Storage has persistent and temporary modes.

For persistent mode data is stored in the ledger and is viewable outside of contracts wherever the ledger is accessible. This is the most universally useful storage mode.

For temporary mode data exists only during the execution time of the top-level contract. It is thus only useful to store data between several cross-contract calls (e.g. to increase and then spend the token allowance from another contract).

Examples

use soroban_sdk::{Env, Symbol};

let storage = env.storage();
let key = Symbol::short("key");
env.storage().set(&key, &1);
assert_eq!(storage.has(&key), true);
assert_eq!(storage.get::<_, i32>(&key), Some(Ok(1)));

Implementations

impl Storage

pub fn has<K>(&self, key: &K) -> boolwhere K: IntoVal<Env, RawVal>,

Returns if there is a value stored for the given key in the currently executing contracts storage.

pub fn get<K, V>(&self, key: &K) -> Option<Result<V, V::Error>>where V::Error: Debug, K: IntoVal<Env, RawVal>, V: TryFromVal<Env, RawVal>,

Returns the value stored for the given key in the currently executing contract’s storage, when present.

Returns None when the value is missing.

If the value is present, then the returned value will be a result of converting the internal value representation to V.

pub fn get_unchecked<K, V>(&self, key: &K) -> Result<V, V::Error>where V::Error: Debug, K: IntoVal<Env, RawVal>, V: TryFromVal<Env, RawVal>,

Returns the value there is a value stored for the given key in the currently executing contract’s storage.

The returned value is a result of converting the internal value representation to V.

Panics

When the key does not have a value stored.

pub fn set<K, V>(&self, key: &K, val: &V)where K: IntoVal<Env, RawVal>, V: IntoVal<Env, RawVal>,

Sets the value for the given key in the currently executing contract’s storage.

If the key already has a value associated with it, the old value is replaced by the new value.

pub fn remove<K>(&self, key: &K)where K: IntoVal<Env, RawVal>,

Removes the key and the corresponding value from the currently executing contract’s storage.

No-op if the key does not exist.

Trait Implementations

impl Clone for Storage

fn clone(&self) -> Storage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Storage

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

Formats the value using the given formatter.