Struct soroban_sdk::data::Data
source · [−]pub struct Data(_);
Expand description
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
sourceimpl Data
impl Data
sourcepub fn has<K>(&self, key: K) -> boolwhere
K: IntoVal<Env, RawVal>,
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.
sourcepub fn get<K, V>(&self, key: K) -> Option<Result<V, V::Error>>where
V::Error: Debug,
K: IntoVal<Env, RawVal>,
V: TryFromVal<Env, RawVal>,
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>,
sourcepub fn get_unchecked<K, V>(&self, key: K) -> Result<V, V::Error>where
V::Error: Debug,
K: IntoVal<Env, RawVal>,
V: TryFromVal<Env, RawVal>,
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.
sourcepub fn set<K, V>(&self, key: K, val: V)where
K: IntoVal<Env, RawVal>,
V: IntoVal<Env, RawVal>,
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
Auto Trait Implementations
impl !RefUnwindSafe for Data
impl !Send for Data
impl !Sync for Data
impl Unpin for Data
impl !UnwindSafe for Data
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read morefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read morefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read morefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more