Struct frame_support::storage::types::StorageMap

pub struct StorageMap<Prefix, Hasher, Key, Value, QueryKind = OptionQuery, OnEmpty = GetDefault, MaxValues = GetDefault>(_);

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, MaxValues> StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues>where
    Prefix: StorageInstance,
    Hasher: StorageHasher,
    Key: FullCodec,
    Value: FullCodec,
    QueryKind: QueryKindTrait<Value, OnEmpty>,
    OnEmpty: Get<QueryKind::Query> + 'static,
    MaxValues: Get<Option<u32>>,

pub fn hashed_key_for<KeyArg: EncodeLike<Key>>(key: KeyArg) -> Vec<u8>

Get the storage key used to fetch a value corresponding to a specific key.

pub fn contains_key<KeyArg: EncodeLike<Key>>(key: KeyArg) -> bool

Does the value (explicitly) exist in storage?

pub fn get<KeyArg: EncodeLike<Key>>(key: KeyArg) -> QueryKind::Query

Load the value associated with the given key from the map.

pub fn try_get<KeyArg: EncodeLike<Key>>(key: KeyArg) -> Result<Value, ()>

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
)

Swap the values of two keys.

pub fn set<KeyArg: EncodeLike<Key>>(key: KeyArg, q: QueryKind::Query)

Store or remove the value to be associated with key so that get returns the query.

pub fn insert<KeyArg: EncodeLike<Key>, ValArg: EncodeLike<Value>>(
    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)

Remove the value under a key.

pub fn mutate<KeyArg: EncodeLike<Key>, R, F: FnOnce(&mut QueryKind::Query) -> R>(
    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>,

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

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>,

Mutate the item, only if an Ok value is returned. Deletes the item if mutated to a None. f will always be called with an option representing if the storage item exists (Some<V>) or if the storage item does not exist (None), independent of the QueryType.

pub fn take<KeyArg: EncodeLike<Key>>(key: KeyArg) -> QueryKind::Query

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>,

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,

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>

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(limit: Option<u32>) -> KillStorageResult

👎Deprecated: Use clear instead

Remove all values of the storage in the overlay and up to limit in the backend.

All values in the client overlay will be deleted, if there is some limit then up to limit values are deleted from the client backend, if limit is none then all values in the client backend are deleted.

Note

Calling this multiple times per block with a limit set leads always to the same keys being removed and the same result being returned. This happens because the keys to delete in the overlay are not taken into account when deleting keys in the backend.

pub fn clear(limit: u32, maybe_cursor: Option<&[u8]>) -> MultiRemovalResults

Attempt to remove all items from the map.

Returns MultiRemovalResults to inform about the result. Once the resultant maybe_cursor field is None, then no further items remain to be deleted.

NOTE: After the initial call for any given map, it is important that no further items are inserted into the map. If so, then the map may not be empty when the resultant maybe_cursor is None.

Limit

A limit must always be provided through in order to cap the maximum amount of deletions done in a single call. This is one fewer than the maximum number of backend iterations which may be done by this operation and as such represents the maximum number of backend deletions which may happen. A limit of zero implies that no keys will be deleted, though there may be a single iteration done.

Cursor

A cursor may be passed in to this operation with maybe_cursor. None should only be passed once (in the initial call) for any given storage map. Subsequent calls operating on the same map should always pass Some, and this should be equal to the previous call result’s maybe_cursor field.

pub fn iter_values() -> PrefixIterator<Value>

Iter over all value of the storage.

NOTE: If a value failed to decode because storage is corrupted then it is skipped.

pub fn translate_values<OldValue: Decode, F: FnMut(OldValue) -> Option<Value>>(
    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.

pub fn try_append<KArg, Item, EncodeLikeItem>(
    key: KArg,
    item: EncodeLikeItem
) -> Result<(), ()>where
    KArg: EncodeLike<Key> + Clone,
    Item: Encode,
    EncodeLikeItem: EncodeLike<Item>,
    Value: StorageTryAppend<Item>,

Try and append the given item to the value in the storage.

Is only available if Value of the storage implements StorageTryAppend.

impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues>where
    Prefix: StorageInstance,
    Hasher: StorageHasher + ReversibleStorageHasher,
    Key: FullCodec,
    Value: FullCodec,
    QueryKind: QueryKindTrait<Value, OnEmpty>,
    OnEmpty: Get<QueryKind::Query> + 'static,
    MaxValues: Get<Option<u32>>,

pub fn iter() -> PrefixIterator<(Key, Value)>

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 iter_from(starting_raw_key: Vec<u8>) -> PrefixIterator<(Key, Value)>

Enumerate all elements in the map after a specified starting_raw_key in no particular order.

If you alter the map while doing this, you’ll get undefined results.

pub fn iter_keys() -> KeyPrefixIterator<Key>

Enumerate all keys in the map in no particular order.

If you alter the map while doing this, you’ll get undefined results.

pub fn iter_keys_from(starting_raw_key: Vec<u8>) -> KeyPrefixIterator<Key>

Enumerate all keys in the map after a specified starting_raw_key in no particular order.

If you alter the map while doing this, you’ll get undefined results.

pub fn drain() -> PrefixIterator<(Key, Value)>

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)

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, MaxValues> PartialStorageInfoTrait for StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues>where
    Prefix: StorageInstance,
    Hasher: StorageHasher,
    Key: FullCodec,
    Value: FullCodec,
    QueryKind: QueryKindTrait<Value, OnEmpty>,
    OnEmpty: Get<QueryKind::Query> + 'static,
    MaxValues: Get<Option<u32>>,

It doesn’t require to implement MaxEncodedLen and give no information for max_size.

fn partial_storage_info() -> Vec<StorageInfo>

impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> StorageEntryMetadataBuilder for StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues>where
    Prefix: StorageInstance,
    Hasher: StorageHasher,
    Key: FullCodec + StaticTypeInfo,
    Value: FullCodec + StaticTypeInfo,
    QueryKind: QueryKindTrait<Value, OnEmpty>,
    OnEmpty: Get<QueryKind::Query> + 'static,
    MaxValues: Get<Option<u32>>,

fn build_metadata(
    docs: Vec<&'static str>,
    entries: &mut Vec<StorageEntryMetadata>
)

Build into entries the storage metadata entries of a storage given some docs.

impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> StorageInfoTrait for StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues>where
    Prefix: StorageInstance,
    Hasher: StorageHasher,
    Key: FullCodec + MaxEncodedLen,
    Value: FullCodec + MaxEncodedLen,
    QueryKind: QueryKindTrait<Value, OnEmpty>,
    OnEmpty: Get<QueryKind::Query> + 'static,
    MaxValues: Get<Option<u32>>,

fn storage_info() -> Vec<StorageInfo>

impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> StoragePrefixedMap<Value> for StorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues>where
    Prefix: StorageInstance,
    Hasher: StorageHasher,
    Key: FullCodec,
    Value: FullCodec,
    QueryKind: QueryKindTrait<Value, OnEmpty>,
    OnEmpty: Get<QueryKind::Query> + 'static,
    MaxValues: Get<Option<u32>>,

fn module_prefix() -> &'static [u8]

Module prefix. Used for generating final key.

fn storage_prefix() -> &'static [u8]

Storage prefix. Used for generating final key.

fn final_prefix() -> [u8; 32]

Final full prefix that prefixes all keys.

fn remove_all(limit: Option<u32>) -> KillStorageResult

👎Deprecated: Use clear instead

Remove all values in the overlay and up to limit in the backend.

fn clear(limit: u32, maybe_cursor: Option<&[u8]>) -> MultiRemovalResults

Attempt to remove all items from the map.

fn iter_values() -> PrefixIterator<Value>

Iter over all value of the storage.

fn translate_values<OldValue: Decode, F: FnMut(OldValue) -> Option<Value>>(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.