Struct frame_support::storage::types::StorageMap

source ·

pub struct StorageMap<Prefix, Hasher, Key, Value, QueryKind = OptionQuery, OnEmpty = GetDefault, MaxValues = GetDefault>(/* private fields */);

Expand description

A type representing a map in storage. A storage map is a mapping of keys to values of a given type stored on-chain.

For general information regarding the #[pallet::storage] attribute, refer to crate::pallet_macros::storage.

§Example

#[frame_support::pallet]
mod pallet {
	/// A kitchen-sink StorageMap, with all possible additional attributes.
    #[pallet::storage]
	#[pallet::getter(fn foo)]
	#[pallet::storage_prefix = "OtherFoo"]
	#[pallet::unbounded]
    pub type Foo<T> = StorageMap<
		_,
		Blake2_128Concat,
		u32,
		u32,
		ValueQuery
	>;

	/// Alternative named syntax.
    #[pallet::storage]
    pub type Bar<T> = StorageMap<
		Hasher = Blake2_128Concat,
		Key = u32,
		Value = u32,
		QueryKind = ValueQuery
	>;
}

Implementations§

source §

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

source

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.

source

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

Does the value (explicitly) exist in storage?

source

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

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

source

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.

source

pub fn swap<KeyArg1: EncodeLike<Key>, KeyArg2: EncodeLike<Key>>( key1: KeyArg1, key2: KeyArg2 )

Swap the values of two keys.

source

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.

source

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.

source

pub fn remove<KeyArg: EncodeLike<Key>>(key: KeyArg)

Remove the value under a key.

source

pub fn mutate<KeyArg: EncodeLike<Key>, R, F: FnOnce(&mut QueryKind::Query) -> R>( key: KeyArg, f: F ) -> R

Mutate the value under a key.

source

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.

source

pub fn mutate_extant<KeyArg: EncodeLike<Key>, R: Default, F: FnOnce(&mut Value) -> R>( key: KeyArg, f: F ) -> R

Mutate the value under a key iff it exists. Do nothing and return the default value if not.

source

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.

source

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.

source

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

Take the value under a key.

source

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.

source

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 completely ignored by this function.

source

pub fn decode_non_dedup_len<KeyArg: EncodeLike<Key>>( key: KeyArg ) -> Option<usize>
where Value: StorageDecodeNonDedupLength,

Read the length of the storage value without decoding the entire value.

Value is required to implement StorageDecodeNonDedupLength.

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 completely ignored by this function.
The value returned is the non-deduplicated length of the underlying Vector in storage.This means that any duplicate items are included.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source §