Struct gear_common::storage::WaitlistImpl

pub struct WaitlistImpl<T, Value, BlockNumber, Error, OutputError, Callbacks, KeyGen>(/* private fields */)
where
    T: DoubleMapStorage<Value = (Value, Interval<BlockNumber>)>,
    Error: WaitlistError,
    OutputError: From<Error>,
    Callbacks: WaitlistCallbacks<Value = Value, BlockNumber = BlockNumber>,
    KeyGen: KeyFor<Key = (T::Key1, T::Key2), Value = Value>;

Waitlist implementation based on DoubleMapStorage.

Generic parameter Error requires WaitlistError implementation. Generic parameter KeyGen presents key generation for given values. Generic parameter Callbacks presents actions for success operations over waitlist.

Trait Implementations

impl<T, Value, BlockNumber, Error, OutputError, Callbacks, KeyGen> CountedByKey for WaitlistImpl<T, Value, BlockNumber, Error, OutputError, Callbacks, KeyGen>

where T: DoubleMapStorage<Value = (Value, Interval<BlockNumber>)> + CountedByKey<Key = T::Key1>, Error: WaitlistError, OutputError: From<Error>, Callbacks: WaitlistCallbacks<Value = Value, BlockNumber = BlockNumber>, KeyGen: KeyFor<Key = (T::Key1, T::Key2), Value = Value>,

type Key = <T as DoubleMapStorage>::Key1

Key type of counting target.

type Length = <T as CountedByKey>::Length

Returning length type.

fn len(key: &Self::Key) -> Self::Length

Returns current Self’s amount of elements as Length type.

fn is_empty(key: &Self::Key) -> bool

Returns bool, defining if Self doesn’t contain elements.

impl<T, Value, BlockNumber, Error, OutputError, Callbacks, KeyGen> IterableByKeyMap<<T as DoubleMapStorage>::Value> for WaitlistImpl<T, Value, BlockNumber, Error, OutputError, Callbacks, KeyGen>

where T: DoubleMapStorage<Value = (Value, Interval<BlockNumber>)> + IterableByKeyMap<T::Value, Key = T::Key1>, Error: WaitlistError, OutputError: From<Error>, Callbacks: WaitlistCallbacks<Value = Value, BlockNumber = BlockNumber>, KeyGen: KeyFor<Key = (T::Key1, T::Key2), Value = Value>,

type Key = <T as DoubleMapStorage>::Key1

Map’s first key type.

type DrainIter = <T as IterableByKeyMap<<T as DoubleMapStorage>::Value>>::DrainIter

Removal iterator type.

type Iter = <T as IterableByKeyMap<<T as DoubleMapStorage>::Value>>::Iter

Getting iterator type.

fn drain_key(key: Self::Key) -> Self::DrainIter

Creates the removal iterator over double map Items.

fn iter_key(key: Self::Key) -> Self::Iter

Creates the getting iterator over double map Items.

impl<T, Value, BlockNumber, Error, OutputError, Callbacks, KeyGen> IterableMap<<T as DoubleMapStorage>::Value> for WaitlistImpl<T, Value, BlockNumber, Error, OutputError, Callbacks, KeyGen>

where T: DoubleMapStorage<Value = (Value, Interval<BlockNumber>)> + IterableMap<T::Value>, Error: WaitlistError, OutputError: From<Error>, Callbacks: WaitlistCallbacks<Value = Value, BlockNumber = BlockNumber>, KeyGen: KeyFor<Key = (T::Key1, T::Key2), Value = Value>,

type DrainIter = <T as IterableMap<<T as DoubleMapStorage>::Value>>::DrainIter

Removal iterator type.

type Iter = <T as IterableMap<<T as DoubleMapStorage>::Value>>::Iter

Getting iterator type.

fn drain() -> Self::DrainIter

Creates the removal iterator over map Items.

fn iter() -> Self::Iter

Creates the getting iterator over map Items.

impl<T, Value, BlockNumber, Error, OutputError, Callbacks, KeyGen> Waitlist for WaitlistImpl<T, Value, BlockNumber, Error, OutputError, Callbacks, KeyGen>

where T: DoubleMapStorage<Value = (Value, Interval<BlockNumber>)>, Error: WaitlistError, OutputError: From<Error>, Callbacks: WaitlistCallbacks<Value = Value, BlockNumber = BlockNumber>, KeyGen: KeyFor<Key = (T::Key1, T::Key2), Value = Value>,

type Key1 = <T as DoubleMapStorage>::Key1

First key type.

type Key2 = <T as DoubleMapStorage>::Key2

Second key type.

type Value = Value

Stored values type.

type BlockNumber = BlockNumber

Block number type.

type Error = Error

Inner error type of waitlist storing algorithm.

type OutputError = OutputError

Output error type of the waitlist.

fn contains(program_id: &Self::Key1, message_id: &Self::Key2) -> bool

Returns bool, defining does first key’s waitlist contain second key.

fn insert( message: Self::Value, scheduled_at: Self::BlockNumber, ) -> Result<(), Self::OutputError>

Inserts given value in waitlist.

fn remove( program_id: Self::Key1, message_id: Self::Key2, ) -> Result<(Self::Value, Interval<Self::BlockNumber>), Self::OutputError>

Removes and returns value from waitlist by given keys, if present, else returns error.

fn clear()

Removes all values from all key’s waitlisted.