Struct soroban_sdk::Map
source · [−]#[repr(transparent)]pub struct Map<K, V>(_, _, _);
Expand description
Map is a key-value dictionary.
The map is stored in the Host and available to the Guest through the functions defined on Map. Values stored in the Map are transmitted to the Host as RawVals, and when retrieved from the Map are transmitted back and converted from RawVal back into their type.
The keys and values in a Map are not guaranteed to be of type K
/V
and
conversion will fail if they are not. Most functions on Map return a
Result
due to this.
Maps may have no more than one entry per key. Setting an value for a key in the map that already has a value for that key replaces the value.
Maps are sorted by their key, and iterating a map is consistent and stable.
Map values can be stored as ContractData, or in other types like Vec, Map, etc.
Examples
use soroban_sdk::{Env, Map, map};
let env = Env::default();
let map = map![&env, (1, 10), (2, 20)];
assert_eq!(map.len(), 2);
Implementations
sourceimpl<K, V> Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
impl<K, V> Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
pub fn env(&self) -> &Env
pub fn new(env: &Env) -> Map<K, V>
pub fn from_array<const N: usize>(env: &Env, items: [(K, V); N]) -> Map<K, V>
pub fn contains_key(&self, k: K) -> bool
pub fn get(&self, k: K) -> Option<Result<V, V::Error>>
pub fn get_unchecked(&self, k: K) -> Result<V, V::Error>
pub fn set(&mut self, k: K, v: V)
pub fn remove(&mut self, k: K) -> Option<()>
pub fn remove_unchecked(&mut self, k: K)
pub fn is_empty(&self) -> bool
pub fn len(&self) -> u32
pub fn keys(&self) -> Vec<K>
pub fn values(&self) -> Vec<V>
pub fn iter(&self) -> MapIter<K, V> where
K: Clone,
V: Clone,
pub fn iter_unchecked(
&self
) -> UncheckedIter<MapIter<K, V>, (K, V), ConversionError>ⓘNotable traits for UncheckedIter<I, T, E>impl<I, T, E> Iterator for UncheckedIter<I, T, E> where
I: Iterator<Item = Result<T, E>>,
E: Debug, type Item = T;
where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal> + Clone,
K::Error: Debug,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal> + Clone,
V::Error: Debug,
I: Iterator<Item = Result<T, E>>,
E: Debug, type Item = T;
pub fn into_iter_unchecked(
self
) -> UncheckedIter<MapIter<K, V>, (K, V), ConversionError>ⓘNotable traits for UncheckedIter<I, T, E>impl<I, T, E> Iterator for UncheckedIter<I, T, E> where
I: Iterator<Item = Result<T, E>>,
E: Debug, type Item = T;
where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal> + Clone,
K::Error: Debug,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal> + Clone,
V::Error: Debug,
I: Iterator<Item = Result<T, E>>,
E: Debug, type Item = T;
Trait Implementations
sourceimpl<K, V> Debug for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal> + Debug + Clone,
K::Error: Debug,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal> + Debug + Clone,
V::Error: Debug,
impl<K, V> Debug for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal> + Debug + Clone,
K::Error: Debug,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal> + Debug + Clone,
V::Error: Debug,
sourceimpl<K, V> From<Map<K, V>> for EnvVal where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
impl<K, V> From<Map<K, V>> for EnvVal where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
sourceimpl<K, V> From<Map<K, V>> for EnvVal<Env, Object> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
impl<K, V> From<Map<K, V>> for EnvVal<Env, Object> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
sourceimpl<K, V> From<Map<K, V>> for RawVal where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
impl<K, V> From<Map<K, V>> for RawVal where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
sourceimpl<K, V> IntoIterator for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
impl<K, V> IntoIterator for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
sourceimpl<K, V> Ord for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
impl<K, V> Ord for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl<K, V> PartialEq<Map<K, V>> for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
impl<K, V> PartialEq<Map<K, V>> for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
sourceimpl<K, V> PartialOrd<Map<K, V>> for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
impl<K, V> PartialOrd<Map<K, V>> for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
sourcefn partial_cmp(&self, other: &Self) -> Option<Ordering>
fn partial_cmp(&self, other: &Self) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl<K, V> TryFrom<EnvVal<Env, Object>> for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
impl<K, V> TryFrom<EnvVal<Env, Object>> for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
sourceimpl<K, V> TryFrom<EnvVal<Env, RawVal>> for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
impl<K, V> TryFrom<EnvVal<Env, RawVal>> for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
sourceimpl<K, V> TryFrom<EnvVal<Env, ScVal>> for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
impl<K, V> TryFrom<EnvVal<Env, ScVal>> for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
sourceimpl<K, V> TryIntoVal<Env, Map<K, V>> for RawVal where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
impl<K, V> TryIntoVal<Env, Map<K, V>> for RawVal where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
type Error = ConversionError
fn try_into_val(self, env: &Env) -> Result<Map<K, V>, Self::Error>
fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>
sourceimpl<K, V> TryIntoVal<Env, Map<K, V>> for ScVal where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
impl<K, V> TryIntoVal<Env, Map<K, V>> for ScVal where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
type Error = ConversionError
fn try_into_val(self, env: &Env) -> Result<Map<K, V>, Self::Error>
fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>
impl<K, V> Eq for Map<K, V> where
K: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
V: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,
Auto Trait Implementations
impl<K, V> !RefUnwindSafe for Map<K, V>
impl<K, V> !Send for Map<K, V>
impl<K, V> !Sync for Map<K, V>
impl<K, V> Unpin for Map<K, V> where
K: Unpin,
V: Unpin,
impl<K, V> !UnwindSafe for Map<K, V>
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