Struct frame_support::pallet_prelude::StorageMap [−][src]
A type that allow to store value for given key. Allowing to insert/remove/iterate on values.
Each value is stored at:
Twox128(Prefix::pallet_prefix())
++ Twox128(Prefix::STORAGE_PREFIX)
++ Hasher1(encode(key))
Warning
If the keys are not trusted (e.g. can be set by a user), a cryptographic hasher
such as
blake2_128_concat
must be used. Otherwise, other values in storage can be compromised.
Implementations
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> where
Prefix: StorageInstance,
Hasher: StorageHasher,
Key: FullCodec,
Value: FullCodec,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
[src]
Prefix: StorageInstance,
Hasher: StorageHasher,
Key: FullCodec,
Value: FullCodec,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
pub fn hashed_key_for<KeyArg: EncodeLike<Key>>(key: KeyArg) -> Vec<u8>ⓘ
[src]
Get the storage key used to fetch a value corresponding to a specific key.
pub fn contains_key<KeyArg: EncodeLike<Key>>(key: KeyArg) -> bool
[src]
Does the value (explicitly) exist in storage?
pub fn get<KeyArg: EncodeLike<Key>>(key: KeyArg) -> QueryKind::Query
[src]
Load the value associated with the given key from the map.
pub fn try_get<KeyArg: EncodeLike<Key>>(key: KeyArg) -> Result<Value, ()>
[src]
Try to get the value for the given key from the map.
Returns Ok
if it exists, Err
if not.
pub fn swap<KeyArg1: EncodeLike<Key>, KeyArg2: EncodeLike<Key>>(
key1: KeyArg1,
key2: KeyArg2
)
[src]
key1: KeyArg1,
key2: KeyArg2
)
Swap the values of two keys.
pub fn insert<KeyArg: EncodeLike<Key>, ValArg: EncodeLike<Value>>(
key: KeyArg,
val: ValArg
)
[src]
key: KeyArg,
val: ValArg
)
Store a value to be associated with the given key from the map.
pub fn remove<KeyArg: EncodeLike<Key>>(key: KeyArg)
[src]
Remove the value under a key.
pub fn mutate<KeyArg: EncodeLike<Key>, R, F: FnOnce(&mut QueryKind::Query) -> R>(
key: KeyArg,
f: F
) -> R
[src]
key: KeyArg,
f: F
) -> R
Mutate the value under a key.
pub fn try_mutate<KeyArg, R, E, F>(key: KeyArg, f: F) -> Result<R, E> where
KeyArg: EncodeLike<Key>,
F: FnOnce(&mut QueryKind::Query) -> Result<R, E>,
[src]
KeyArg: EncodeLike<Key>,
F: FnOnce(&mut QueryKind::Query) -> Result<R, E>,
Mutate the item, only if an Ok
value is returned.
pub fn mutate_exists<KeyArg: EncodeLike<Key>, R, F: FnOnce(&mut Option<Value>) -> R>(
key: KeyArg,
f: F
) -> R
[src]
key: KeyArg,
f: F
) -> R
Mutate the value under a key. Deletes the item if mutated to a None
.
pub fn try_mutate_exists<KeyArg, R, E, F>(key: KeyArg, f: F) -> Result<R, E> where
KeyArg: EncodeLike<Key>,
F: FnOnce(&mut Option<Value>) -> Result<R, E>,
[src]
KeyArg: EncodeLike<Key>,
F: FnOnce(&mut Option<Value>) -> Result<R, E>,
Mutate the item, only if an Ok
value is returned. Deletes the item if mutated to a None
.
pub fn take<KeyArg: EncodeLike<Key>>(key: KeyArg) -> QueryKind::Query
[src]
Take the value under a key.
pub fn append<Item, EncodeLikeItem, EncodeLikeKey>(
key: EncodeLikeKey,
item: EncodeLikeItem
) where
EncodeLikeKey: EncodeLike<Key>,
Item: Encode,
EncodeLikeItem: EncodeLike<Item>,
Value: StorageAppend<Item>,
[src]
key: EncodeLikeKey,
item: EncodeLikeItem
) where
EncodeLikeKey: EncodeLike<Key>,
Item: Encode,
EncodeLikeItem: EncodeLike<Item>,
Value: StorageAppend<Item>,
Append the given items to the value in the storage.
Value
is required to implement codec::EncodeAppend
.
Warning
If the storage item is not encoded properly, the storage will be overwritten
and set to [item]
. Any default value set for the storage item will be ignored
on overwrite.
pub fn decode_len<KeyArg: EncodeLike<Key>>(key: KeyArg) -> Option<usize> where
Value: StorageDecodeLength,
[src]
Value: StorageDecodeLength,
Read the length of the storage value without decoding the entire value under the
given key
.
Value
is required to implement StorageDecodeLength
.
If the value does not exists or it fails to decode the length, None
is returned.
Otherwise Some(len)
is returned.
Warning
None
does not mean that get()
does not return a value. The default value is completly
ignored by this function.
pub fn migrate_key<OldHasher: StorageHasher, KeyArg: EncodeLike<Key>>(
key: KeyArg
) -> Option<Value>
[src]
key: KeyArg
) -> Option<Value>
Migrate an item with the given key
from a defunct OldHasher
to the current hasher.
If the key doesn’t exist, then it’s a no-op. If it does, then it returns its value.
pub fn remove_all()
[src]
Remove all value of the storage.
pub fn iter_values() -> PrefixIterator<Value>ⓘNotable traits for PrefixIterator<T>
impl<T> Iterator for PrefixIterator<T> type Item = T;
[src]
Notable traits for PrefixIterator<T>
impl<T> Iterator for PrefixIterator<T> type Item = T;
Iter over all value of the storage.
NOTE: If a value failed to decode becaues storage is corrupted then it is skipped.
pub fn translate_values<OldValue: Decode, F: FnMut(OldValue) -> Option<Value>>(
f: F
)
[src]
f: F
)
Translate the values of all elements by a function f
, in the map in no particular order.
By returning None
from f
for an element, you’ll remove it from the map.
NOTE: If a value fail to decode because storage is corrupted then it is skipped.
Warning
This function must be used with care, before being updated the storage still contains the
old type, thus other calls (such as get
) will fail at decoding it.
Usage
This would typically be called inside the module implementation of on_runtime_upgrade.
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> where
Prefix: StorageInstance,
Hasher: StorageHasher + ReversibleStorageHasher,
Key: FullCodec,
Value: FullCodec,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
[src]
Prefix: StorageInstance,
Hasher: StorageHasher + ReversibleStorageHasher,
Key: FullCodec,
Value: FullCodec,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
pub fn iter() -> PrefixIterator<(Key, Value)>ⓘNotable traits for PrefixIterator<T>
impl<T> Iterator for PrefixIterator<T> type Item = T;
[src]
Notable traits for PrefixIterator<T>
impl<T> Iterator for PrefixIterator<T> type Item = T;
Enumerate all elements in the map in no particular order.
If you alter the map while doing this, you’ll get undefined results.
pub fn drain() -> PrefixIterator<(Key, Value)>ⓘNotable traits for PrefixIterator<T>
impl<T> Iterator for PrefixIterator<T> type Item = T;
[src]
Notable traits for PrefixIterator<T>
impl<T> Iterator for PrefixIterator<T> type Item = T;
Remove all elements from the map and iterate through them in no particular order.
If you add elements to the map while doing this, you’ll get undefined results.
pub fn translate<O: Decode, F: FnMut(Key, O) -> Option<Value>>(f: F)
[src]
Translate the values of all elements by a function f
, in the map in no particular order.
By returning None
from f
for an element, you’ll remove it from the map.
NOTE: If a value fail to decode because storage is corrupted then it is skipped.
Trait Implementations
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> StorageMapMetadata for StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> where
Prefix: StorageInstance,
Hasher: StorageHasher,
Key: FullCodec,
Value: FullCodec,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
[src]
Prefix: StorageInstance,
Hasher: StorageHasher,
Key: FullCodec,
Value: FullCodec,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
const MODIFIER: StorageEntryModifier
[src]
const HASHER: StorageHasher
[src]
const NAME: &'static str
[src]
const DEFAULT: DefaultByteGetter
[src]
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> StoragePrefixedMap<Value> for StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> where
Prefix: StorageInstance,
Hasher: StorageHasher,
Key: FullCodec,
Value: FullCodec,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
[src]
Prefix: StorageInstance,
Hasher: StorageHasher,
Key: FullCodec,
Value: FullCodec,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
fn module_prefix() -> &'static [u8]ⓘ
[src]
fn storage_prefix() -> &'static [u8]ⓘ
[src]
fn final_prefix() -> [u8; 32]
[src]
fn remove_all()
[src]
fn iter_values() -> PrefixIterator<Value>ⓘNotable traits for PrefixIterator<T>
impl<T> Iterator for PrefixIterator<T> type Item = T;
[src]
Notable traits for PrefixIterator<T>
impl<T> Iterator for PrefixIterator<T> type Item = T;
fn translate_values<OldValue: Decode, F: FnMut(OldValue) -> Option<Value>>(f: F)
[src]
Auto Trait Implementations
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> RefUnwindSafe for StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> where
Hasher: RefUnwindSafe,
Key: RefUnwindSafe,
OnEmpty: RefUnwindSafe,
Prefix: RefUnwindSafe,
QueryKind: RefUnwindSafe,
Value: RefUnwindSafe,
Hasher: RefUnwindSafe,
Key: RefUnwindSafe,
OnEmpty: RefUnwindSafe,
Prefix: RefUnwindSafe,
QueryKind: RefUnwindSafe,
Value: RefUnwindSafe,
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> Send for StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> where
Hasher: Send,
Key: Send,
OnEmpty: Send,
Prefix: Send,
QueryKind: Send,
Value: Send,
Hasher: Send,
Key: Send,
OnEmpty: Send,
Prefix: Send,
QueryKind: Send,
Value: Send,
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> Sync for StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> where
Hasher: Sync,
Key: Sync,
OnEmpty: Sync,
Prefix: Sync,
QueryKind: Sync,
Value: Sync,
Hasher: Sync,
Key: Sync,
OnEmpty: Sync,
Prefix: Sync,
QueryKind: Sync,
Value: Sync,
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> Unpin for StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> where
Hasher: Unpin,
Key: Unpin,
OnEmpty: Unpin,
Prefix: Unpin,
QueryKind: Unpin,
Value: Unpin,
Hasher: Unpin,
Key: Unpin,
OnEmpty: Unpin,
Prefix: Unpin,
QueryKind: Unpin,
Value: Unpin,
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> UnwindSafe for StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty> where
Hasher: UnwindSafe,
Key: UnwindSafe,
OnEmpty: UnwindSafe,
Prefix: UnwindSafe,
QueryKind: UnwindSafe,
Value: UnwindSafe,
Hasher: UnwindSafe,
Key: UnwindSafe,
OnEmpty: UnwindSafe,
Prefix: UnwindSafe,
QueryKind: UnwindSafe,
Value: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> CheckedConversion for T
[src]
pub fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,
[src]
Self: TryFrom<T>,
pub fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,
[src]
Self: TryInto<T>,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> IsType<T> for T
[src]
pub fn from_ref(&T) -> &T
[src]
pub fn into_ref(&Self) -> &T
[src]
pub fn from_mut(&mut T) -> &mut T
[src]
pub fn into_mut(&mut Self) -> &mut T
[src]
impl<T, Outer> IsWrappedBy<Outer> for T where
T: From<Outer>,
Outer: AsRef<T> + AsMut<T> + From<T>,
[src]
T: From<Outer>,
Outer: AsRef<T> + AsMut<T> + From<T>,
pub fn from_ref(outer: &Outer) -> &T
[src]
Get a reference to the inner from the outer.
pub fn from_mut(outer: &mut Outer) -> &mut T
[src]
Get a mutable reference to the inner from the outer.
impl<T> MaybeRefUnwindSafe for T where
T: RefUnwindSafe,
[src]
T: RefUnwindSafe,
impl<T> Same<T> for T
[src]
type Output = T
Should always be Self
impl<T> SaturatedConversion for T
[src]
pub fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,
[src]
Self: UniqueSaturatedFrom<T>,
pub fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,
[src]
Self: UniqueSaturatedInto<T>,
impl<K, V, G> StorageMap<K, V> for G where
K: FullEncode,
V: FullCodec,
G: StorageMap<K, V>,
[src]
K: FullEncode,
V: FullCodec,
G: StorageMap<K, V>,
type Query = <G as StorageMap<K, V>>::Query
The type that get/take return.
pub fn hashed_key_for<KeyArg>(KeyArg) -> Vec<u8, Global>ⓘ where
KeyArg: EncodeLike<K>,
[src]
KeyArg: EncodeLike<K>,
pub fn swap<KeyArg1, KeyArg2>(KeyArg1, KeyArg2) where
KeyArg1: EncodeLike<K>,
KeyArg2: EncodeLike<K>,
[src]
KeyArg1: EncodeLike<K>,
KeyArg2: EncodeLike<K>,
pub fn contains_key<KeyArg>(KeyArg) -> bool where
KeyArg: EncodeLike<K>,
[src]
KeyArg: EncodeLike<K>,
pub fn get<KeyArg>(KeyArg) -> <G as StorageMap<K, V>>::Query where
KeyArg: EncodeLike<K>,
[src]
KeyArg: EncodeLike<K>,
pub fn try_get<KeyArg>(KeyArg) -> Result<V, ()> where
KeyArg: EncodeLike<K>,
[src]
KeyArg: EncodeLike<K>,
pub fn insert<KeyArg, ValArg>(KeyArg, ValArg) where
KeyArg: EncodeLike<K>,
ValArg: EncodeLike<V>,
[src]
KeyArg: EncodeLike<K>,
ValArg: EncodeLike<V>,
pub fn remove<KeyArg>(KeyArg) where
KeyArg: EncodeLike<K>,
[src]
KeyArg: EncodeLike<K>,
pub fn mutate<KeyArg, R, F>(KeyArg, F) -> R where
F: FnOnce(&mut <G as StorageMap<K, V>>::Query) -> R,
KeyArg: EncodeLike<K>,
[src]
F: FnOnce(&mut <G as StorageMap<K, V>>::Query) -> R,
KeyArg: EncodeLike<K>,
pub fn mutate_exists<KeyArg, R, F>(KeyArg, F) -> R where
F: FnOnce(&mut Option<V>) -> R,
KeyArg: EncodeLike<K>,
[src]
F: FnOnce(&mut Option<V>) -> R,
KeyArg: EncodeLike<K>,
pub fn try_mutate<KeyArg, R, E, F>(KeyArg, F) -> Result<R, E> where
F: FnOnce(&mut <G as StorageMap<K, V>>::Query) -> Result<R, E>,
KeyArg: EncodeLike<K>,
[src]
F: FnOnce(&mut <G as StorageMap<K, V>>::Query) -> Result<R, E>,
KeyArg: EncodeLike<K>,
pub fn try_mutate_exists<KeyArg, R, E, F>(KeyArg, F) -> Result<R, E> where
F: FnOnce(&mut Option<V>) -> Result<R, E>,
KeyArg: EncodeLike<K>,
[src]
F: FnOnce(&mut Option<V>) -> Result<R, E>,
KeyArg: EncodeLike<K>,
pub fn take<KeyArg>(KeyArg) -> <G as StorageMap<K, V>>::Query where
KeyArg: EncodeLike<K>,
[src]
KeyArg: EncodeLike<K>,
pub fn append<Item, EncodeLikeItem, EncodeLikeKey>(
EncodeLikeKey,
EncodeLikeItem
) where
Item: Encode,
EncodeLikeItem: EncodeLike<Item>,
V: StorageAppend<Item>,
EncodeLikeKey: EncodeLike<K>,
[src]
EncodeLikeKey,
EncodeLikeItem
) where
Item: Encode,
EncodeLikeItem: EncodeLike<Item>,
V: StorageAppend<Item>,
EncodeLikeKey: EncodeLike<K>,
pub fn migrate_key<OldHasher, KeyArg>(KeyArg) -> Option<V> where
KeyArg: EncodeLike<K>,
OldHasher: StorageHasher,
[src]
KeyArg: EncodeLike<K>,
OldHasher: StorageHasher,
fn decode_len<KeyArg: EncodeLike<K>>(key: KeyArg) -> Option<usize> where
V: StorageDecodeLength,
[src]
V: StorageDecodeLength,
fn migrate_key_from_blake<KeyArg: EncodeLike<K>>(key: KeyArg) -> Option<V>
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,
[src]
T: UncheckedFrom<S>,
pub fn unchecked_into(self) -> T
[src]
impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,
[src]
T: Bounded,
S: TryInto<T>,
pub fn unique_saturated_into(self) -> T
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
[src]
V: MultiLane<T>,