Trait gear_common::storage::TripleMapStorage

pub trait TripleMapStorage {
    type Key1;
    type Key2;
    type Key3;
    type Value;

    // Required methods
    fn contains_keys(
        key1: &Self::Key1,
        key2: &Self::Key2,
        key3: &Self::Key3,
    ) -> bool;
    fn get(
        key1: &Self::Key1,
        key2: &Self::Key2,
        key3: &Self::Key3,
    ) -> Option<Self::Value>;
    fn insert(
        key1: Self::Key1,
        key2: Self::Key2,
        key3: Self::Key3,
        value: Self::Value,
    );
    fn mutate<R, F: FnOnce(&mut Option<Self::Value>) -> R>(
        key1: Self::Key1,
        key2: Self::Key2,
        key3: Self::Key3,
        f: F,
    ) -> R;
    fn mutate_values<F: FnMut(Self::Value) -> Self::Value>(f: F);
    fn remove(key1: Self::Key1, key2: Self::Key2, key3: Self::Key3);
    fn clear();
    fn take(
        key1: Self::Key1,
        key2: Self::Key2,
        key3: Self::Key3,
    ) -> Option<Self::Value>;
    fn clear_prefix(key1: Self::Key1, key2: Self::Key2);
    fn iter_prefix(
        key1: &Self::Key1,
        key2: &Self::Key2,
    ) -> impl Iterator<Item = (Self::Key3, Self::Value)>;

    // Provided method
    fn mutate_exists<R, F: FnOnce(&mut Self::Value) -> R>(
        key1: Self::Key1,
        key2: Self::Key2,
        key3: Self::Key3,
        f: F,
    ) -> Option<R> { ... }
}

Represents logic of managing globally stored triple-key map for more complicated logic.

In fact, represents custom implementation/wrapper around of Substrate’s StorageNMap with OptionQuery.

Required Associated Types

type Key1

Map’s first key type.

type Key2

Map’s second key type.

type Key3

Map’s third key type.

type Value

Map’s stored value type.

Required Methods

fn contains_keys( key1: &Self::Key1, key2: &Self::Key2, key3: &Self::Key3, ) -> bool

Returns bool, defining does map contain value under given keys.

fn get( key1: &Self::Key1, key2: &Self::Key2, key3: &Self::Key3, ) -> Option<Self::Value>

Gets value stored under given keys, if present.

fn insert( key1: Self::Key1, key2: Self::Key2, key3: Self::Key3, value: Self::Value, )

Inserts value with given keys.

fn mutate<R, F: FnOnce(&mut Option<Self::Value>) -> R>( key1: Self::Key1, key2: Self::Key2, key3: Self::Key3, f: F, ) -> R

Mutates value by Option reference, which stored (or not in None case) under given keys with given function.

May return generic type value.

fn mutate_values<F: FnMut(Self::Value) -> Self::Value>(f: F)

Mutates all stored values with given convert function.

fn remove(key1: Self::Key1, key2: Self::Key2, key3: Self::Key3)

Removes value stored under the given keys.

fn clear()

Removes all values.

fn take( key1: Self::Key1, key2: Self::Key2, key3: Self::Key3, ) -> Option<Self::Value>

Gets value stored under given keys, if present, and removes it from storage.

fn clear_prefix(key1: Self::Key1, key2: Self::Key2)

Remove items from the map matching a key1/key2 prefix.

fn iter_prefix( key1: &Self::Key1, key2: &Self::Key2, ) -> impl Iterator<Item = (Self::Key3, Self::Value)>

Provided Methods

fn mutate_exists<R, F: FnOnce(&mut Self::Value) -> R>( key1: Self::Key1, key2: Self::Key2, key3: Self::Key3, f: F, ) -> Option<R>

Works the same as Self::mutate, but triggers if value present.

Object Safety

This trait is not object safe.

Implementors