Struct soroban_sdk::data::Data

pub struct Data(_);

Data stores and retrieves data for the currently executing contract.

All data stored can only be queried and modified by the contract that stores it. Other contracts cannot query or modify data stored by other contracts. Data is stored in the ledger and viewable outside of contracts where-ever the ledger is accessible.

Examples

use soroban_sdk::{Env, Symbol};

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

Implementations

impl Data

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 data.

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 there is a value stored for the given key in the currently executing contracts data.

Panics

When the key does not have a value stored.

When the value stored cannot be converted into the type expected.

TODO

Add safe checked versions of these functions.

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 contracts data.

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 contracts data.

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>,

Trait Implementations

impl Clone for Data

fn clone(&self) -> Data

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Data

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

Formats the value using the given formatter.