referrerpolicy=no-referrer-when-downgrade
frame_support::storage::types

Struct StorageDoubleMap

Source 
pub struct StorageDoubleMap<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind = OptionQuery, OnEmpty = GetDefault, MaxValues = GetDefault>(/* private fields */);
Expand description

A type representing a double map in storage. This structure associates a pair of keys with a value of a specified type stored on-chain.

A double map with keys k1 and k2 can be likened to a StorageMap with a key of type (k1, k2). However, a double map offers functions specific to each key, enabling partial iteration and deletion based on one key alone.

Also, conceptually, a double map is a special case of a StorageNMap using two keys.

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

§Examples

§Kitchen-sink

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

	/// Alternative named syntax.
    #[pallet::storage]
    pub type Bar<T> = StorageDoubleMap<
        Hasher1 = Blake2_128Concat,
        Key1 = u8,
        Hasher2 = Twox64Concat,
        Key2 = u16,
        Value = u32,
        QueryKind = ValueQuery
    >;
}

§Partial Iteration & Removal

When Hasher1 and Hasher2 implement the ReversibleStorageHasher trait, the first key k1 can be used to partially iterate over keys and values of the double map, and to delete items.

ⓘ
#[test]
fn example_double_map_partial_operations() {
	type FooDoubleMap =
		StorageDoubleMap<Prefix, Blake2_128Concat, u32, Blake2_128Concat, u32, u32, ValueQuery>;

	TestExternalities::default().execute_with(|| {
		FooDoubleMap::insert(0, 0, 42);
		FooDoubleMap::insert(0, 1, 43);
		FooDoubleMap::insert(1, 0, 314);

		// should be equal to {0,1} (ordering is random)
		let collected_k2_keys: BTreeSet<_> = FooDoubleMap::iter_key_prefix(0).collect();
		assert_eq!(collected_k2_keys, [0, 1].iter().copied().collect::<BTreeSet<_>>());

		// should be equal to {42,43} (ordering is random)
		let collected_k2_values: BTreeSet<_> = FooDoubleMap::iter_prefix_values(0).collect();
		assert_eq!(collected_k2_values, [42, 43].iter().copied().collect::<BTreeSet<_>>());

		// Remove items from the map using k1 = 0
		let _ = FooDoubleMap::clear_prefix(0, u32::max_value(), None);
		// Values associated with (0, _) should have been removed
		assert_eq!(FooDoubleMap::iter_prefix(0).collect::<Vec<_>>(), vec![]);
	});
}

Implementations§

Source§

impl<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues> StorageDoubleMap<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues>
where Prefix: StorageInstance, Hasher1: StorageHasher, Hasher2: StorageHasher, Key1: FullCodec, Key2: FullCodec, Value: FullCodec, QueryKind: QueryKindTrait<Value, OnEmpty>, OnEmpty: Get<QueryKind::Query> + 'static, MaxValues: Get<Option<u32>>,

Source

pub fn hashed_key_for<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Vec<u8> ⓘ
where KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>,

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

Source

pub fn contains_key<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> bool
where KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>,

Does the value (explicitly) exist in storage?

Source

pub fn get<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> QueryKind::Query
where KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>,

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

Source

pub fn try_get<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Result<Value, ()>
where KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>,

Try to get the value for the given key from the double map.

Returns Ok if it exists, Err if not.

Source

pub fn set<KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>>( k1: KArg1, k2: KArg2, q: QueryKind::Query, )

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

Source

pub fn take<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> QueryKind::Query
where KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>,

Take a value from storage, removing it afterwards.

Source

pub fn swap<XKArg1, XKArg2, YKArg1, YKArg2>( x_k1: XKArg1, x_k2: XKArg2, y_k1: YKArg1, y_k2: YKArg2, )
where XKArg1: EncodeLike<Key1>, XKArg2: EncodeLike<Key2>, YKArg1: EncodeLike<Key1>, YKArg2: EncodeLike<Key2>,

Swap the values of two key-pairs.

Source

pub fn insert<KArg1, KArg2, VArg>(k1: KArg1, k2: KArg2, val: VArg)
where KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>, VArg: EncodeLike<Value>,

Store a value to be associated with the given keys from the double map.

Source

pub fn remove<KArg1, KArg2>(k1: KArg1, k2: KArg2)
where KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>,

Remove the value under the given keys.

Source

pub fn remove_prefix<KArg1>(k1: KArg1, limit: Option<u32>) -> KillStorageResult
where KArg1: ?Sized + EncodeLike<Key1>,

👎Deprecated: Use clear_prefix instead

Remove all values under k1 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_prefix<KArg1>( first_key: KArg1, limit: u32, maybe_cursor: Option<&[u8]>, ) -> MultiRemovalResults
where KArg1: ?Sized + EncodeLike<Key1>,

Attempt to remove items from the map matching a first_key prefix.

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 which match the first_key. 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 and first_key. Subsequent calls operating on the same map/first_key should always pass Some, and this should be equal to the previous call result’s maybe_cursor field.

Source

pub fn iter_prefix_values<KArg1>(k1: KArg1) -> PrefixIterator<Value> ⓘ
where KArg1: ?Sized + EncodeLike<Key1>,

Iterate over values that share the first key.

Source

pub fn mutate<KArg1, KArg2, R, F>(k1: KArg1, k2: KArg2, f: F) -> R
where KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>, F: FnOnce(&mut QueryKind::Query) -> R,

Mutate the value under the given keys.

Source

pub fn try_mutate<KArg1, KArg2, R, E, F>( k1: KArg1, k2: KArg2, f: F, ) -> Result<R, E>
where KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>, F: FnOnce(&mut QueryKind::Query) -> Result<R, E>,

Mutate the value under the given keys when the closure returns Ok.

Source

pub fn mutate_exists<KArg1, KArg2, R, F>(k1: KArg1, k2: KArg2, f: F) -> R
where KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>, F: FnOnce(&mut Option<Value>) -> R,

Mutate the value under the given keys. Deletes the item if mutated to a None.

Source

pub fn try_mutate_exists<KArg1, KArg2, R, E, F>( k1: KArg1, k2: KArg2, f: F, ) -> Result<R, E>
where KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>, 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 append<Item, EncodeLikeItem, KArg1, KArg2>( k1: KArg1, k2: KArg2, item: EncodeLikeItem, )
where KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>, Item: Encode, EncodeLikeItem: EncodeLike<Item>, Value: StorageAppend<Item>,

Append the given item to the value in the storage.

Value is required to implement StorageAppend.

§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<KArg1, KArg2>(key1: KArg1, key2: KArg2) -> Option<usize>
where KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>, Value: StorageDecodeLength,

Read the length of the storage value without decoding the entire value under the given key1 and key2.

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<KArg1, KArg2>( key1: KArg1, key2: KArg2, ) -> Option<usize>
where KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>, 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_keys<OldHasher1: StorageHasher, OldHasher2: StorageHasher, KeyArg1: EncodeLike<Key1>, KeyArg2: EncodeLike<Key2>>( key1: KeyArg1, key2: KeyArg2, ) -> Option<Value>

Migrate an item with the given key1 and key2 from defunct OldHasher1 and OldHasher2 to the current hashers.

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 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<KArg1, KArg2, Item, EncodeLikeItem>( key1: KArg1, key2: KArg2, item: EncodeLikeItem, ) -> Result<(), ()>
where KArg1: EncodeLike<Key1> + Clone, KArg2: EncodeLike<Key2> + 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§

impl<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues> StorageDoubleMap<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues>
where Prefix: StorageInstance, Hasher1: StorageHasher + ReversibleStorageHasher, Hasher2: StorageHasher + ReversibleStorageHasher, Key1: FullCodec, Key2: FullCodec, Value: FullCodec, QueryKind: QueryKindTrait<Value, OnEmpty>, OnEmpty: Get<QueryKind::Query> + 'static, MaxValues: Get<Option<u32>>,

Source

pub fn iter_prefix(k1: impl EncodeLike<Key1>) -> PrefixIterator<(Key2, Value)> ⓘ

Enumerate all elements in the map with first key k1 in no particular order.

If you add or remove values whose first key is k1 to the map while doing this, you’ll get undefined results.

Source

pub fn iter_prefix_from( k1: impl EncodeLike<Key1>, starting_raw_key: Vec<u8>, ) -> PrefixIterator<(Key2, Value)> ⓘ

Enumerate all elements in the map with first key k1 after a specified starting_raw_key in no particular order.

If you add or remove values whose first key is k1 to the map while doing this, you’ll get undefined results.

Source

pub fn iter_key_prefix(k1: impl EncodeLike<Key1>) -> KeyPrefixIterator<Key2> ⓘ

Enumerate all second keys k2 in the map with the same first key k1 in no particular order.

If you add or remove values whose first key is k1 to the map while doing this, you’ll get undefined results.

Source

pub fn iter_key_prefix_from( k1: impl EncodeLike<Key1>, starting_raw_key: Vec<u8>, ) -> KeyPrefixIterator<Key2> ⓘ

Enumerate all second keys k2 in the map with the same first key k1 after a specified starting_raw_key in no particular order.

If you add or remove values whose first key is k1 to the map while doing this, you’ll get undefined results.

Source

pub fn drain_prefix(k1: impl EncodeLike<Key1>) -> PrefixIterator<(Key2, Value)> ⓘ

Remove all elements from the map with first key k1 and iterate through them in no particular order.

If you add elements with first key k1 to the map while doing this, you’ll get undefined results.

Source

pub fn iter() -> PrefixIterator<(Key1, Key2, Value)> ⓘ

Enumerate all elements in the map in no particular order.

If you add or remove values to the map while doing this, you’ll get undefined results.

Source

pub fn iter_from( starting_raw_key: Vec<u8>, ) -> PrefixIterator<(Key1, Key2, Value)> ⓘ

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

If you add or remove values to the map while doing this, you’ll get undefined results.

Source

pub fn iter_keys() -> KeyPrefixIterator<(Key1, Key2)> ⓘ

Enumerate all keys k1 and k2 in the map in no particular order.

If you add or remove values to the map while doing this, you’ll get undefined results.

Source

pub fn iter_keys_from( starting_raw_key: Vec<u8>, ) -> KeyPrefixIterator<(Key1, Key2)> ⓘ

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

If you add or remove values to the map while doing this, you’ll get undefined results.

Source

pub fn drain() -> PrefixIterator<(Key1, Key2, 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.

Source

pub fn translate<O: Decode, F: FnMut(Key1, Key2, 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§

Source§

impl<Prefix, Hasher1, Hasher2, Key1, Key2, Value, QueryKind, OnEmpty, MaxValues> PartialStorageInfoTrait for StorageDoubleMap<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues>
where Prefix: StorageInstance, Hasher1: StorageHasher, Hasher2: StorageHasher, Key1: FullCodec, Key2: 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.

Source§

fn partial_storage_info() -> Vec<StorageInfo>

Source§

impl<Prefix, Hasher1, Hasher2, Key1, Key2, Value, QueryKind, OnEmpty, MaxValues> StorageEntryMetadataBuilder for StorageDoubleMap<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues>
where Prefix: StorageInstance, Hasher1: StorageHasher, Hasher2: StorageHasher, Key1: FullCodec + StaticTypeInfo, Key2: FullCodec + StaticTypeInfo, Value: FullCodec + StaticTypeInfo, QueryKind: QueryKindTrait<Value, OnEmpty>, OnEmpty: Get<QueryKind::Query> + 'static, MaxValues: Get<Option<u32>>,

Source§

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

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

impl<Prefix, Hasher1, Hasher2, Key1, Key2, Value, QueryKind, OnEmpty, MaxValues> StorageInfoTrait for StorageDoubleMap<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues>
where Prefix: StorageInstance, Hasher1: StorageHasher, Hasher2: StorageHasher, Key1: FullCodec + MaxEncodedLen, Key2: FullCodec + MaxEncodedLen, Value: FullCodec + MaxEncodedLen, QueryKind: QueryKindTrait<Value, OnEmpty>, OnEmpty: Get<QueryKind::Query> + 'static, MaxValues: Get<Option<u32>>,

Source§

fn storage_info() -> Vec<StorageInfo>

Source§

impl<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues> StoragePrefixedMap<Value> for StorageDoubleMap<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues>
where Prefix: StorageInstance, Hasher1: StorageHasher, Hasher2: StorageHasher, Key1: FullCodec, Key2: FullCodec, Value: FullCodec, QueryKind: QueryKindTrait<Value, OnEmpty>, OnEmpty: Get<QueryKind::Query> + 'static, MaxValues: Get<Option<u32>>,

Source§

fn pallet_prefix() -> &'static [u8] ⓘ

Pallet prefix. Used for generating final key.
Source§

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

Storage prefix. Used for generating final key.
Source§

fn final_prefix() -> [u8; 32]

Final full prefix that prefixes all keys.
Source§

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

👎Deprecated: Use clear instead
Remove all values in the overlay and up to limit in the backend. Read more
Source§

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

Attempt to remove all items from the map. Read more
Source§

fn iter_values() -> PrefixIterator<Value> ⓘ

Iter over all value of the storage. Read more
Source§

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. Read more
Source§

impl<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues> TryDecodeEntireStorage for StorageDoubleMap<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues>
where Prefix: StorageInstance, Hasher1: StorageHasher, Key1: FullCodec, Hasher2: StorageHasher, Key2: FullCodec, Value: FullCodec, QueryKind: QueryKindTrait<Value, OnEmpty>, OnEmpty: Get<QueryKind::Query> + 'static, MaxValues: Get<Option<u32>>,

Source§

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

Auto Trait Implementations§

§

impl<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues> Freeze for StorageDoubleMap<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues>

§

impl<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues> RefUnwindSafe for StorageDoubleMap<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues>
where Prefix: RefUnwindSafe, Hasher1: RefUnwindSafe, Key1: RefUnwindSafe, Hasher2: RefUnwindSafe, Key2: RefUnwindSafe, Value: RefUnwindSafe, QueryKind: RefUnwindSafe, OnEmpty: RefUnwindSafe, MaxValues: RefUnwindSafe,

§

impl<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues> Send for StorageDoubleMap<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues>
where Prefix: Send, Hasher1: Send, Key1: Send, Hasher2: Send, Key2: Send, Value: Send, QueryKind: Send, OnEmpty: Send, MaxValues: Send,

§

impl<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues> Sync for StorageDoubleMap<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues>
where Prefix: Sync, Hasher1: Sync, Key1: Sync, Hasher2: Sync, Key2: Sync, Value: Sync, QueryKind: Sync, OnEmpty: Sync, MaxValues: Sync,

§

impl<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues> Unpin for StorageDoubleMap<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues>
where Prefix: Unpin, Hasher1: Unpin, Key1: Unpin, Hasher2: Unpin, Key2: Unpin, Value: Unpin, QueryKind: Unpin, OnEmpty: Unpin, MaxValues: Unpin,

§

impl<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues> UnwindSafe for StorageDoubleMap<Prefix, Hasher1, Key1, Hasher2, Key2, Value, QueryKind, OnEmpty, MaxValues>
where Prefix: UnwindSafe, Hasher1: UnwindSafe, Key1: UnwindSafe, Hasher2: UnwindSafe, Key2: UnwindSafe, Value: UnwindSafe, QueryKind: UnwindSafe, OnEmpty: UnwindSafe, MaxValues: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CheckedConversion for T

Source§

fn checked_from<T>(t: T) -> Option<Self>
where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more
Source§

fn checked_into<T>(self) -> Option<T>
where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T, U> DefensiveTruncateInto<U> for T
where U: DefensiveTruncateFrom<T>,

Source§

fn defensive_truncate_into(self) -> U

Defensively truncate a value and convert it into its bounded form.
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> IntoKey<U> for T
where U: FromKey<T>,

Source§

fn into_key(self) -> U

§

impl<Src, Dest> IntoTuple<Dest> for Src
where Dest: FromTuple<Src>,

§

fn into_tuple(self) -> Dest

Source§

impl<T> IsType<T> for T

Source§

fn from_ref(t: &T) -> &T

Cast reference.
Source§

fn into_ref(&self) -> &T

Cast reference.
Source§

fn from_mut(t: &mut T) -> &mut T

Cast mutable reference.
Source§

fn into_mut(&mut self) -> &mut T

Cast mutable reference.
Source§

impl<T, Outer> IsWrappedBy<Outer> for T
where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

Source§

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

Source§

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatedConversion for T

Source§

fn saturated_from<T>(t: T) -> Self
where Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more
Source§

fn saturated_into<T>(self) -> T
where Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more
Source§

impl<K1, K2, V, G> StorageDoubleMap<K1, K2, V> for G
where K1: FullEncode, K2: FullEncode, V: FullCodec, G: StorageDoubleMap<K1, K2, V>,

Source§

type Query = <G as StorageDoubleMap<K1, K2, V>>::Query

The type that get/take returns.
Source§

fn hashed_key_for<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Vec<u8> ⓘ
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>,

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

fn contains_key<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> bool
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>,

Does the value (explicitly) exist in storage?
Source§

fn get<KArg1, KArg2>( k1: KArg1, k2: KArg2, ) -> <G as StorageDoubleMap<K1, K2, V>>::Query
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>,

Load the value associated with the given key from the double map.
Source§

fn try_get<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Result<V, ()>
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>,

Try to get the value for the given key from the double map. Read more
Source§

fn set<KArg1, KArg2>( k1: KArg1, k2: KArg2, q: <G as StorageDoubleMap<K1, K2, V>>::Query, )
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>,

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

fn take<KArg1, KArg2>( k1: KArg1, k2: KArg2, ) -> <G as StorageDoubleMap<K1, K2, V>>::Query
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>,

Take a value from storage, removing it afterwards.
Source§

fn swap<XKArg1, XKArg2, YKArg1, YKArg2>( x_k1: XKArg1, x_k2: XKArg2, y_k1: YKArg1, y_k2: YKArg2, )
where XKArg1: EncodeLike<K1>, XKArg2: EncodeLike<K2>, YKArg1: EncodeLike<K1>, YKArg2: EncodeLike<K2>,

Swap the values of two key-pairs.
Source§

fn insert<KArg1, KArg2, VArg>(k1: KArg1, k2: KArg2, val: VArg)
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, VArg: EncodeLike<V>,

Store a value to be associated with the given keys from the double map.
Source§

fn remove<KArg1, KArg2>(k1: KArg1, k2: KArg2)
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>,

Remove the value under the given keys.
Source§

fn remove_prefix<KArg1>( k1: KArg1, maybe_limit: Option<u32>, ) -> KillStorageResult
where KArg1: EncodeLike<K1>,

👎Deprecated: Use clear_prefix instead
Remove all values under the first key k1 in the overlay and up to limit in the backend. Read more
Source§

fn clear_prefix<KArg1>( k1: KArg1, limit: u32, maybe_cursor: Option<&[u8]>, ) -> MultiRemovalResults
where KArg1: EncodeLike<K1>,

Remove all values under the first key k1 in the overlay and up to maybe_limit in the backend. Read more
Source§

fn contains_prefix<KArg1>(k1: KArg1) -> bool
where KArg1: EncodeLike<K1>,

Does any value under the first key k1 (explicitly) exist in storage? Might have unexpected behaviour with empty keys, e.g. [].
Source§

fn iter_prefix_values<KArg1>(k1: KArg1) -> PrefixIterator<V> ⓘ
where KArg1: EncodeLike<K1> + ?Sized,

Iterate over values that share the first key.
Source§

fn mutate<KArg1, KArg2, R, F>(k1: KArg1, k2: KArg2, f: F) -> R
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, F: FnOnce(&mut <G as StorageDoubleMap<K1, K2, V>>::Query) -> R,

Mutate the value under the given keys.
Source§

fn mutate_exists<KArg1, KArg2, R, F>(k1: KArg1, k2: KArg2, f: F) -> R
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, F: FnOnce(&mut Option<V>) -> R,

Mutate the value under the given keys. Deletes the item if mutated to a None.
Source§

fn try_mutate<KArg1, KArg2, R, E, F>(k1: KArg1, k2: KArg2, f: F) -> Result<R, E>
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, F: FnOnce(&mut <G as StorageDoubleMap<K1, K2, V>>::Query) -> Result<R, E>,

Mutate the value under the given keys when the closure returns Ok.
Source§

fn try_mutate_exists<KArg1, KArg2, R, E, F>( k1: KArg1, k2: KArg2, f: F, ) -> Result<R, E>
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, F: FnOnce(&mut Option<V>) -> 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§

fn append<Item, EncodeLikeItem, KArg1, KArg2>( k1: KArg1, k2: KArg2, item: EncodeLikeItem, )
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, Item: Encode, EncodeLikeItem: EncodeLike<Item>, V: StorageAppend<Item>,

Append the given item to the value in the storage. Read more
Source§

fn migrate_keys<OldHasher1, OldHasher2, KeyArg1, KeyArg2>( key1: KeyArg1, key2: KeyArg2, ) -> Option<V>
where OldHasher1: StorageHasher, OldHasher2: StorageHasher, KeyArg1: EncodeLike<K1>, KeyArg2: EncodeLike<K2>,

Migrate an item with the given key1 and key2 from defunct OldHasher1 and OldHasher2 to the current hashers. Read more
Source§

fn decode_len<KArg1, KArg2>(key1: KArg1, key2: KArg2) -> Option<usize>
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, V: StorageDecodeLength,

Read the length of the storage value without decoding the entire value under the given key1 and key2. Read more
Source§

fn decode_non_dedup_len<KArg1, KArg2>(key1: KArg1, key2: KArg2) -> Option<usize>
where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, V: StorageDecodeNonDedupLength,

Read the length of the storage value without decoding the entire value under the given key1 and key2. Read more
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<K1, K2, T, I, StorageDoubleMapT> TryAppendDoubleMap<K1, K2, T, I> for StorageDoubleMapT
where K1: FullCodec, K2: FullCodec, T: FullCodec + StorageTryAppend<I>, I: Encode, StorageDoubleMapT: StorageDoubleMap<K1, K2, T>,

Source§

fn try_append<LikeK1, LikeK2, LikeI>( key1: LikeK1, key2: LikeK2, item: LikeI, ) -> Result<(), ()>
where LikeK1: EncodeLike<K1> + Clone, LikeK2: EncodeLike<K2> + Clone, LikeI: EncodeLike<I>,

Try and append the item into the storage double map at the given key. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T, U> TryIntoKey<U> for T
where U: TryFromKey<T>,

Source§

type Error = <U as TryFromKey<T>>::Error

Source§

fn try_into_key(self) -> Result<U, <U as TryFromKey<T>>::Error>

Source§

impl<S, T> UncheckedInto<T> for S
where T: UncheckedFrom<S>,

Source§

fn unchecked_into(self) -> T

The counterpart to unchecked_from.
Source§

impl<T, S> UniqueSaturatedInto<T> for S
where T: Bounded, S: TryInto<T>,

Source§

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> JsonSchemaMaybe for T

Source§

impl<T> MaybeRefUnwindSafe for T
where T: RefUnwindSafe,