Trait gear_common::storage::Mailbox

pub trait Mailbox {
    type Key1;
    type Key2;
    type Value;
    type BlockNumber;
    type Error: MailboxError;
    type OutputError: From<Self::Error>;

    // Required methods
    fn contains(key1: &Self::Key1, key2: &Self::Key2) -> bool;
    fn insert(
        value: Self::Value,
        bn: Self::BlockNumber,
    ) -> Result<(), Self::OutputError>;
    fn remove(
        key1: Self::Key1,
        key2: Self::Key2,
    ) -> Result<(Self::Value, Interval<Self::BlockNumber>), Self::OutputError>;
    fn peek(key1: &Self::Key1, key2: &Self::Key2) -> Option<Self::Value>;
    fn clear();
}

Represents mailbox managing logic.

Required Associated Types

type Key1

First key type.

type Key2

Second key type.

type Value

Stored values type.

type BlockNumber

Block number type.

Stored with Self::Value.

type Error: MailboxError

Inner error type of mailbox storing algorithm.

type OutputError: From<Self::Error>

Output error type of the mailbox.

Required Methods

fn contains(key1: &Self::Key1, key2: &Self::Key2) -> bool

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

fn insert( value: Self::Value, bn: Self::BlockNumber, ) -> Result<(), Self::OutputError>

Inserts given value in mailbox.

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

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

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

Peeks into the mailbox using the given keys to return a message, if present. Does not destroy the message.

fn clear()

Removes all values from all key’s mailboxes.

Object Safety

This trait is not object safe.

Implementors

impl<T, Value, BlockNumber, Error, OutputError, Callbacks, KeyGen> Mailbox for MailboxImpl<T, Value, BlockNumber, Error, OutputError, Callbacks, KeyGen>

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

type Key1 = <T as DoubleMapStorage>::Key1

type Key2 = <T as DoubleMapStorage>::Key2

type Value = Value

type BlockNumber = BlockNumber

type Error = Error

type OutputError = OutputError