pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-06-12 19:21:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve doc for storages in srml-support (#3982)

Browse Source 
* improve doc

* Apply suggestions from code review
This commit is contained in:
thiolliere
2019-10-31 19:04:53 +01:00
committed by Kian Paimani
parent 363c8989d4
commit 984163e86e
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/srml/support/src/storage/mod.rs
+12
View File
@@ -28,6 +28,9 @@ pub mod child;
pub mod generator;
/// A trait for working with macro-generated storage values under the substrate storage API.
///
/// Details on implementation can be found at
/// [`generator::StorageValue`]
pub trait StorageValue<T: FullCodec> {
/// The type that get/take return.
type Query;
@@ -113,6 +116,9 @@ pub trait StorageValue<T: FullCodec> {
}
/// A strongly-typed map in storage.
///
/// Details on implementation can be found at
/// [`generator::StorageMap`]
pub trait StorageMap<K: FullEncode, V: FullCodec> {
/// The type that get/take return.
type Query;
@@ -180,6 +186,9 @@ pub trait StorageMap<K: FullEncode, V: FullCodec> {
/// A strongly-typed linked map in storage.
///
/// Similar to `StorageMap` but allows to enumerate other elements and doesn't implement append.
///
/// Details on implementation can be found at
/// [`generator::StorageLinkedMap`]
pub trait StorageLinkedMap<K: FullCodec, V: FullCodec> {
/// The type that get/take return.
type Query;
@@ -229,6 +238,9 @@ pub trait StorageLinkedMap<K: FullCodec, V: FullCodec> {
///
/// It provides an important ability to efficiently remove all entries
/// that have a common first key.
///
/// Details on implementation can be found at
/// [`generator::StorageDoubleMap`]
pub trait StorageDoubleMap<K1: FullEncode, K2: FullEncode, V: FullCodec> {
/// The type that get/take returns.
type Query;