Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Introduce set function into storage maps #11564

Merged
merged 2 commits into from
Jun 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions frame/support/src/storage/generator/double_map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,13 @@ where
unhashed::get(&Self::storage_double_map_final_key(k1, k2)).ok_or(())
}

fn set<KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>>(k1: KArg1, k2: KArg2, q: Self::Query) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
fn set<KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>>(k1: KArg1, k2: KArg2, q: Self::Query) {
fn set<KArg1, KArg2>(k1: KArg1, k2: KArg2, q: Self::Query)
where
KArg1: EncodeLike<K1>,
KArg2: EncodeLike<K2>,
{

match G::from_query_to_optional_value(q) {
Some(v) => Self::insert(k1, k2, v),
None => Self::remove(k1, k2),
}
}

fn take<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Self::Query
where
KArg1: EncodeLike<K1>,
Expand Down
7 changes: 7 additions & 0 deletions frame/support/src/storage/generator/map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,13 @@ impl<K: FullEncode, V: FullCodec, G: StorageMap<K, V>> storage::StorageMap<K, V>
unhashed::get(Self::storage_map_final_key(key).as_ref()).ok_or(())
}

fn set<KeyArg: EncodeLike<K>>(key: KeyArg, q: Self::Query) {
match G::from_query_to_optional_value(q) {
Some(v) => Self::insert(key, v),
None => Self::remove(key),
}
}

fn insert<KeyArg: EncodeLike<K>, ValArg: EncodeLike<V>>(key: KeyArg, val: ValArg) {
unhashed::put(Self::storage_map_final_key(key).as_ref(), &val)
}
Expand Down
7 changes: 7 additions & 0 deletions frame/support/src/storage/generator/nmap.rs
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,13 @@ where
unhashed::get(&Self::storage_n_map_final_key::<K, _>(key)).ok_or(())
}

fn set<KArg: EncodeLikeTuple<K::KArg> + TupleToEncodedIter>(key: KArg, q: Self::Query) {
match G::from_query_to_optional_value(q) {
Some(v) => Self::insert(key, v),
None => Self::remove(key),
}
}

fn take<KArg: EncodeLikeTuple<K::KArg> + TupleToEncodedIter>(key: KArg) -> Self::Query {
let final_key = Self::storage_n_map_final_key::<K, _>(key);

Expand Down
9 changes: 9 additions & 0 deletions frame/support/src/storage/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,9 @@ pub trait StorageMap<K: FullEncode, V: FullCodec> {
/// Load the value associated with the given key from the map.
fn get<KeyArg: EncodeLike<K>>(key: KeyArg) -> Self::Query;

/// Store or remove the value to be associated with `key` so that `get` returns the `query`.
fn set<KeyArg: EncodeLike<K>>(key: KeyArg, query: Self::Query);

/// Try to get the value for the given key from the map.
///
/// Returns `Ok` if it exists, `Err` if not.
Expand Down Expand Up @@ -481,6 +484,9 @@ pub trait StorageDoubleMap<K1: FullEncode, K2: FullEncode, V: FullCodec> {
KArg1: EncodeLike<K1>,
KArg2: EncodeLike<K2>;

/// Store or remove the value to be associated with `key` so that `get` returns the `query`.
fn set<KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>>(k1: KArg1, k2: KArg2, query: Self::Query);

/// Take a value from storage, removing it afterwards.
fn take<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Self::Query
where
Expand Down Expand Up @@ -657,6 +663,9 @@ pub trait StorageNMap<K: KeyGenerator, V: FullCodec> {
/// Returns `Ok` if it exists, `Err` if not.
fn try_get<KArg: EncodeLikeTuple<K::KArg> + TupleToEncodedIter>(key: KArg) -> Result<V, ()>;

/// Store or remove the value to be associated with `key` so that `get` returns the `query`.
fn set<KArg: EncodeLikeTuple<K::KArg> + TupleToEncodedIter>(key: KArg, query: Self::Query);

/// Swap the values of two keys.
fn swap<KOther, KArg1, KArg2>(key1: KArg1, key2: KArg2)
where
Expand Down
5 changes: 5 additions & 0 deletions frame/support/src/storage/types/counted_map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,11 @@ where
<Self as MapWrapper>::Map::try_get(key)
}

/// Store or remove the value to be associated with `key` so that `get` returns the `query`.
pub fn set<KeyArg: EncodeLike<Key>>(key: KeyArg, q: QueryKind::Query) {
<Self as MapWrapper>::Map::set(key, q)
}

/// Swap the values of two keys.
pub fn swap<KeyArg1: EncodeLike<Key>, KeyArg2: EncodeLike<Key>>(key1: KeyArg1, key2: KeyArg2) {
<Self as MapWrapper>::Map::swap(key1, key2)
Expand Down
9 changes: 9 additions & 0 deletions frame/support/src/storage/types/double_map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,15 @@ where
<Self as crate::storage::StorageDoubleMap<Key1, Key2, Value>>::try_get(k1, k2)
}

/// Store or remove the value to be associated with `key` so that `get` returns the `query`.
pub fn set<KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>>(
k1: KArg1,
k2: KArg2,
q: QueryKind::Query,
) {
Comment on lines +207 to +211
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
pub fn set<KArg1: EncodeLike<Key1>, KArg2: EncodeLike<Key2>>(
k1: KArg1,
k2: KArg2,
q: QueryKind::Query,
) {
pub fn set<KArg1, KArg2>(k1: KArg1, k2: KArg2, q: Self::Query)
where
KArg1: EncodeLike<K1>,
KArg2: EncodeLike<K2>,
{

<Self as crate::storage::StorageDoubleMap<Key1, Key2, Value>>::set(k1, k2, q)
}

/// Take a value from storage, removing it afterwards.
pub fn take<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> QueryKind::Query
where
Expand Down
5 changes: 5 additions & 0 deletions frame/support/src/storage/types/map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,11 @@ where
<Self as crate::storage::StorageMap<Key, Value>>::swap(key1, key2)
}

/// Store or remove the value to be associated with `key` so that `get` returns the `query`.
pub fn set<KeyArg: EncodeLike<Key>>(key: KeyArg, q: QueryKind::Query) {
<Self as crate::storage::StorageMap<Key, Value>>::set(key, q)
}

/// Store a value to be associated with the given key from the map.
pub fn insert<KeyArg: EncodeLike<Key>, ValArg: EncodeLike<Value>>(key: KeyArg, val: ValArg) {
<Self as crate::storage::StorageMap<Key, Value>>::insert(key, val)
Expand Down
8 changes: 8 additions & 0 deletions frame/support/src/storage/types/nmap.rs
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,14 @@ where
<Self as crate::storage::StorageNMap<Key, Value>>::try_get(key)
}

/// Store or remove the value to be associated with `key` so that `get` returns the `query`.
pub fn set<KArg: EncodeLikeTuple<Key::KArg> + TupleToEncodedIter>(
key: KArg,
query: QueryKind::Query,
) {
<Self as crate::storage::StorageNMap<Key, Value>>::set(key, query)
}

/// Take a value from storage, removing it afterwards.
pub fn take<KArg: EncodeLikeTuple<Key::KArg> + TupleToEncodedIter>(
key: KArg,
Expand Down