Struct cw_storage_plus::IndexedMap
source · pub struct IndexedMap<K, T, I> {
pub idx: I,
/* private fields */
}
Expand description
IndexedMap
works like a Map
but has a secondary index
Fields§
§idx: I
This is meant to be read directly to get the proper types, like: map.idx.owner.items(…)
Implementations§
source§impl<'a, K, T, I> IndexedMap<K, T, I>
impl<'a, K, T, I> IndexedMap<K, T, I>
sourcepub const fn new(pk_namespace: &'static str, indexes: I) -> Self
pub const fn new(pk_namespace: &'static str, indexes: I) -> Self
Creates a new IndexedMap
with the given storage key. This is a constant function only suitable
when you have a prefix in the form of a static string slice.
sourcepub fn new_dyn(pk_namespace: impl Into<Namespace>, indexes: I) -> Self
pub fn new_dyn(pk_namespace: impl Into<Namespace>, indexes: I) -> Self
Creates a new IndexedMap
with the given storage key. Use this if you might need to handle
a dynamic string. Otherwise, you should probably prefer IndexedMap::new
.
pub fn key(&self, k: K) -> Path<T>
source§impl<'a, K, T, I> IndexedMap<K, T, I>
impl<'a, K, T, I> IndexedMap<K, T, I>
sourcepub fn save(&self, store: &mut dyn Storage, key: K, data: &T) -> StdResult<()>
pub fn save(&self, store: &mut dyn Storage, key: K, data: &T) -> StdResult<()>
save will serialize the model and store, returns an error on serialization issues. this must load the old value to update the indexes properly if you loaded the old value earlier in the same function, use replace to avoid needless db reads
pub fn remove(&self, store: &mut dyn Storage, key: K) -> StdResult<()>
sourcepub fn replace(
&self,
store: &mut dyn Storage,
key: K,
data: Option<&T>,
old_data: Option<&T>
) -> StdResult<()>
pub fn replace( &self, store: &mut dyn Storage, key: K, data: Option<&T>, old_data: Option<&T> ) -> StdResult<()>
replace writes data to key. old_data must be the current stored value (from a previous load) and is used to properly update the index. This is used by save, replace, and update and can be called directly if you want to optimize
sourcepub fn update<A, E>(
&self,
store: &mut dyn Storage,
key: K,
action: A
) -> Result<T, E>
pub fn update<A, E>( &self, store: &mut dyn Storage, key: K, action: A ) -> Result<T, E>
Loads the data, perform the specified action, and store the result in the database. This is shorthand for some common sequences, which may be useful.
If the data exists, action(Some(value))
is called. Otherwise action(None)
is called.
sourcepub fn load(&self, store: &dyn Storage, key: K) -> StdResult<T>
pub fn load(&self, store: &dyn Storage, key: K) -> StdResult<T>
load will return an error if no data is set at the given key, or on parse error
sourcepub fn may_load(&self, store: &dyn Storage, key: K) -> StdResult<Option<T>>
pub fn may_load(&self, store: &dyn Storage, key: K) -> StdResult<Option<T>>
may_load will parse the data stored at the key if present, returns Ok(None) if no data there. returns an error on issues parsing
source§impl<'a, K, T, I> IndexedMap<K, T, I>
impl<'a, K, T, I> IndexedMap<K, T, I>
sourcepub fn prefix_range_raw<'c>(
&self,
store: &'c dyn Storage,
min: Option<PrefixBound<'a, K::Prefix>>,
max: Option<PrefixBound<'a, K::Prefix>>,
order: Order
) -> Box<dyn Iterator<Item = StdResult<Record<T>>> + 'c>where
T: 'c,
'a: 'c,
pub fn prefix_range_raw<'c>(
&self,
store: &'c dyn Storage,
min: Option<PrefixBound<'a, K::Prefix>>,
max: Option<PrefixBound<'a, K::Prefix>>,
order: Order
) -> Box<dyn Iterator<Item = StdResult<Record<T>>> + 'c>where
T: 'c,
'a: 'c,
While range_raw
over a prefix
fixes the prefix to one element and iterates over the
remaining, prefix_range_raw
accepts bounds for the lowest and highest elements of the Prefix
itself, and iterates over those (inclusively or exclusively, depending on PrefixBound
).
There are some issues that distinguish these two, and blindly casting to Vec<u8>
doesn’t
solve them.
source§impl<'a, K, T, I> IndexedMap<K, T, I>
impl<'a, K, T, I> IndexedMap<K, T, I>
pub fn sub_prefix( &self, p: K::SubPrefix ) -> Prefix<K::SuperSuffix, T, K::SuperSuffix>
pub fn prefix(&self, p: K::Prefix) -> Prefix<K::Suffix, T, K::Suffix>
source§impl<'a, K, T, I> IndexedMap<K, T, I>
impl<'a, K, T, I> IndexedMap<K, T, I>
sourcepub fn prefix_range<'c>(
&self,
store: &'c dyn Storage,
min: Option<PrefixBound<'a, K::Prefix>>,
max: Option<PrefixBound<'a, K::Prefix>>,
order: Order
) -> Box<dyn Iterator<Item = StdResult<(K::Output, T)>> + 'c>where
T: 'c,
K: 'c,
K::Output: 'static,
'a: 'c,
pub fn prefix_range<'c>(
&self,
store: &'c dyn Storage,
min: Option<PrefixBound<'a, K::Prefix>>,
max: Option<PrefixBound<'a, K::Prefix>>,
order: Order
) -> Box<dyn Iterator<Item = StdResult<(K::Output, T)>> + 'c>where
T: 'c,
K: 'c,
K::Output: 'static,
'a: 'c,
While range
over a prefix
fixes the prefix to one element and iterates over the
remaining, prefix_range
accepts bounds for the lowest and highest elements of the
Prefix
itself, and iterates over those (inclusively or exclusively, depending on
PrefixBound
).
There are some issues that distinguish these two, and blindly casting to Vec<u8>
doesn’t
solve them.