Struct frame_support::pallet_prelude::CountedStorageMap [−][src]
pub struct CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind = OptionQuery, OnEmpty = GetDefault, MaxValues = GetDefault>(_);Expand description
A wrapper around a StorageMap and a StorageValue<Value=u32> to keep track of how many items
are in a map, without needing to iterate all the values.
This storage item has additional storage read and write overhead when manipulating values compared to a regular storage map.
For functions where we only add or remove a value, a single storage read is needed to check if that value already exists. For mutate functions, two storage reads are used to check if the value existed before and after the mutation.
Whenever the counter needs to be updated, an additional read and write occurs to update that counter.
Implementations
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Prefix: CountedStorageMapInstance,
Hasher: StorageHasher,
Key: FullCodec,
Value: FullCodec,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
MaxValues: Get<Option<u32>>,
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Prefix: CountedStorageMapInstance,
Hasher: StorageHasher,
Key: FullCodec,
Value: FullCodec,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
MaxValues: Get<Option<u32>>,
Get the storage key used to fetch a value corresponding to a specific key.
Does the value (explicitly) exist in storage?
Load the value associated with the given key from the map.
Try to get the value for the given key from the map.
Returns Ok if it exists, Err if not.
Swap the values of two keys.
pub fn insert<KeyArg: EncodeLike<Key> + Clone, ValArg: EncodeLike<Value>>(
key: KeyArg,
val: ValArg
)
pub fn insert<KeyArg: EncodeLike<Key> + Clone, ValArg: EncodeLike<Value>>(
key: KeyArg,
val: ValArg
)
Store a value to be associated with the given key from the map.
Remove the value under a key.
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> + Clone,
F: FnOnce(&mut QueryKind::Query) -> Result<R, E>,
pub fn try_mutate<KeyArg, R, E, F>(key: KeyArg, f: F) -> Result<R, E> where
KeyArg: EncodeLike<Key> + Clone,
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> + Clone, R, F: FnOnce(&mut Option<Value>) -> R>(
key: KeyArg,
f: F
) -> R
pub fn mutate_exists<KeyArg: EncodeLike<Key> + Clone, 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> + Clone,
F: FnOnce(&mut Option<Value>) -> Result<R, E>,
pub fn try_mutate_exists<KeyArg, R, E, F>(key: KeyArg, f: F) -> Result<R, E> where
KeyArg: EncodeLike<Key> + Clone,
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.
Take the value under a key.
pub fn append<Item, EncodeLikeItem, EncodeLikeKey>(
key: EncodeLikeKey,
item: EncodeLikeItem
) where
EncodeLikeKey: EncodeLike<Key> + Clone,
Item: Encode,
EncodeLikeItem: EncodeLike<Item>,
Value: StorageAppend<Item>,
pub fn append<Item, EncodeLikeItem, EncodeLikeKey>(
key: EncodeLikeKey,
item: EncodeLikeItem
) where
EncodeLikeKey: EncodeLike<Key> + Clone,
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,
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>
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.
Remove all value of the storage.
pub fn iter_values() -> PrefixIterator<Value, OnRemovalCounterUpdate<Prefix>>ⓘNotable traits for PrefixIterator<T, OnRemoval>impl<T, OnRemoval: PrefixIteratorOnRemoval> Iterator for PrefixIterator<T, OnRemoval> type Item = T;
pub fn iter_values() -> PrefixIterator<Value, OnRemovalCounterUpdate<Prefix>>ⓘNotable traits for PrefixIterator<T, OnRemoval>impl<T, OnRemoval: PrefixIteratorOnRemoval> Iterator for PrefixIterator<T, OnRemoval> type Item = T;
impl<T, OnRemoval: PrefixIteratorOnRemoval> Iterator for PrefixIterator<T, OnRemoval> type Item = T;Iter over all value of the storage.
NOTE: If a value failed to decode because storage is corrupted then it is skipped.
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>,
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.
Initialize the counter with the actual number of items in the map.
This function iterates through all the items in the map and sets the counter. This operation can be very heavy, so use with caution.
Returns the number of items in the map which is used to set the counter.
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Prefix: CountedStorageMapInstance,
Hasher: StorageHasher + ReversibleStorageHasher,
Key: FullCodec,
Value: FullCodec,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
MaxValues: Get<Option<u32>>,
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Prefix: CountedStorageMapInstance,
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), OnRemovalCounterUpdate<Prefix>>ⓘNotable traits for PrefixIterator<T, OnRemoval>impl<T, OnRemoval: PrefixIteratorOnRemoval> Iterator for PrefixIterator<T, OnRemoval> type Item = T;
pub fn iter() -> PrefixIterator<(Key, Value), OnRemovalCounterUpdate<Prefix>>ⓘNotable traits for PrefixIterator<T, OnRemoval>impl<T, OnRemoval: PrefixIteratorOnRemoval> Iterator for PrefixIterator<T, OnRemoval> type Item = T;
impl<T, OnRemoval: PrefixIteratorOnRemoval> Iterator for PrefixIterator<T, OnRemoval> 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), OnRemovalCounterUpdate<Prefix>>ⓘNotable traits for PrefixIterator<T, OnRemoval>impl<T, OnRemoval: PrefixIteratorOnRemoval> Iterator for PrefixIterator<T, OnRemoval> type Item = T;
pub fn drain() -> PrefixIterator<(Key, Value), OnRemovalCounterUpdate<Prefix>>ⓘNotable traits for PrefixIterator<T, OnRemoval>impl<T, OnRemoval: PrefixIteratorOnRemoval> Iterator for PrefixIterator<T, OnRemoval> type Item = T;
impl<T, OnRemoval: PrefixIteratorOnRemoval> Iterator for PrefixIterator<T, OnRemoval> 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.
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 CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Prefix: CountedStorageMapInstance,
Hasher: StorageHasher,
Key: FullCodec,
Value: FullCodec,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
MaxValues: Get<Option<u32>>,
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> PartialStorageInfoTrait for CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Prefix: CountedStorageMapInstance,
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 CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Prefix: CountedStorageMapInstance,
Hasher: StorageHasher,
Key: FullCodec + StaticTypeInfo,
Value: FullCodec + StaticTypeInfo,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
MaxValues: Get<Option<u32>>,
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> StorageEntryMetadataBuilder for CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Prefix: CountedStorageMapInstance,
Hasher: StorageHasher,
Key: FullCodec + StaticTypeInfo,
Value: FullCodec + StaticTypeInfo,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
MaxValues: Get<Option<u32>>,
Build into entries the storage metadata entries of a storage given some docs.
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> StorageInfoTrait for CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Prefix: CountedStorageMapInstance,
Hasher: StorageHasher,
Key: FullCodec + MaxEncodedLen,
Value: FullCodec + MaxEncodedLen,
QueryKind: QueryKindTrait<Value, OnEmpty>,
OnEmpty: Get<QueryKind::Query> + 'static,
MaxValues: Get<Option<u32>>,
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> StorageInfoTrait for CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Prefix: CountedStorageMapInstance,
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>ⓘ
Auto Trait Implementations
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> RefUnwindSafe for CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Hasher: RefUnwindSafe,
Key: RefUnwindSafe,
MaxValues: RefUnwindSafe,
OnEmpty: RefUnwindSafe,
Prefix: RefUnwindSafe,
QueryKind: RefUnwindSafe,
Value: RefUnwindSafe,
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> Send for CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Hasher: Send,
Key: Send,
MaxValues: Send,
OnEmpty: Send,
Prefix: Send,
QueryKind: Send,
Value: Send,
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> Sync for CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Hasher: Sync,
Key: Sync,
MaxValues: Sync,
OnEmpty: Sync,
Prefix: Sync,
QueryKind: Sync,
Value: Sync,
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> Unpin for CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Hasher: Unpin,
Key: Unpin,
MaxValues: Unpin,
OnEmpty: Unpin,
Prefix: Unpin,
QueryKind: Unpin,
Value: Unpin,
impl<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> UnwindSafe for CountedStorageMap<Prefix, Hasher, Key, Value, QueryKind, OnEmpty, MaxValues> where
Hasher: UnwindSafe,
Key: UnwindSafe,
MaxValues: UnwindSafe,
OnEmpty: UnwindSafe,
Prefix: UnwindSafe,
QueryKind: UnwindSafe,
Value: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s. Read more
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s. Read more
Causes self to use its Binary implementation when Debug-formatted.
Causes self to use its Display implementation when
Debug-formatted. Read more
Causes self to use its LowerExp implementation when
Debug-formatted. Read more
Causes self to use its LowerHex implementation when
Debug-formatted. Read more
Causes self to use its Octal implementation when Debug-formatted.
Causes self to use its Pointer implementation when
Debug-formatted. Read more
Causes self to use its UpperExp implementation when
Debug-formatted. Read more
Causes self to use its UpperHex implementation when
Debug-formatted. Read more
Pipes by value. This is generally the method you want to use. Read more
Borrows self and passes that borrow into the pipe function. Read more
Mutably borrows self and passes that borrow into the pipe function. Read more
Borrows self, then passes self.borrow() into the pipe function. Read more
Mutably borrows self, then passes self.borrow_mut() into the pipe
function. Read more
Borrows self, then passes self.as_ref() into the pipe function.
Mutably borrows self, then passes self.as_mut() into the pipe
function. Read more
Borrows self, then passes self.deref() into the pipe function.
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
Pipes a dereference into a function that cannot normally be called in suffix position. Read more
Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more
Immutable access to the Borrow<B> of a value. Read more
Mutable access to the BorrowMut<B> of a value. Read more
Immutable access to the AsRef<R> view of a value. Read more
Mutable access to the AsMut<R> view of a value. Read more
Immutable access to the Deref::Target of a value. Read more
Mutable access to the Deref::Target of a value. Read more
Calls .tap() only in debug builds, and is erased in release builds.
Calls .tap_mut() only in debug builds, and is erased in release
builds. Read more
Calls .tap_borrow() only in debug builds, and is erased in release
builds. Read more
Calls .tap_borrow_mut() only in debug builds, and is erased in release
builds. Read more
Calls .tap_ref() only in debug builds, and is erased in release
builds. Read more
Calls .tap_ref_mut() only in debug builds, and is erased in release
builds. Read more
Calls .tap_deref() only in debug builds, and is erased in release
builds. Read more
Provides immutable access to the reference for inspection.
Calls tap_ref in debug builds, and does nothing in release builds.
Provides mutable access to the reference for modification.
Calls tap_ref_mut in debug builds, and does nothing in release builds.
Provides immutable access to the borrow for inspection. Read more
Calls tap_borrow in debug builds, and does nothing in release builds.
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Provides mutable access to the borrow for modification.
Immutably dereferences self for inspection.
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Calls tap_deref in debug builds, and does nothing in release builds.
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Mutably dereferences self for modification.
The counterpart to unchecked_from.
Consume self to return an equivalent value of T.
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more