Struct soroban_sdk::ContractData
source · [−]pub struct ContractData(_);
Expand description
ContractData 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 contract_data = env.contract_data();
let key = symbol!("key");
env.contract_data().set(key, 1);
assert_eq!(contract_data.has(key), true);
assert_eq!(contract_data.get::<_, i32>(key), Some(Ok(1)));
Implementations
sourceimpl ContractData
impl ContractData
sourcepub fn has<K>(&self, key: K) -> bool where
K: IntoVal<Env, RawVal>,
pub fn has<K>(&self, key: K) -> bool where
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
sourceimpl Clone for ContractData
impl Clone for ContractData
sourcefn clone(&self) -> ContractData
fn clone(&self) -> ContractData
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for ContractData
impl !Send for ContractData
impl !Sync for ContractData
impl Unpin for ContractData
impl !UnwindSafe for ContractData
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
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 T where
T: Any,
impl<T> Downcast for T where
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 more
fn 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 more
fn 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 more
fn 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