Trait gear_common::storage::Queue

pub trait Queue {
    type Value;
    type Error: DequeueError;
    type OutputError: From<Self::Error>;

    // Required methods
    fn dequeue() -> Result<Option<Self::Value>, Self::OutputError>;
    fn mutate_values<F: FnMut(Self::Value) -> Self::Value>(f: F);
    fn queue(value: Self::Value) -> Result<(), Self::OutputError>;
    fn clear();
    fn requeue(value: Self::Value) -> Result<(), Self::OutputError>;
}

Represents message queue managing logic.

Required Associated Types

type Value

Stored values type.

type Error: DequeueError

Inner error type of queue storing algorithm.

type OutputError: From<Self::Error>

Output error type of the queue.

Required Methods

fn dequeue() -> Result<Option<Self::Value>, Self::OutputError>

Removes and returns message from the beginning of the queue, if present,

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

Mutates all values in queue with given function.

fn queue(value: Self::Value) -> Result<(), Self::OutputError>

Inserts given value at the end of the queue.

fn clear()

Removes all values from queue.

fn requeue(value: Self::Value) -> Result<(), Self::OutputError>

Inserts given value at the beginning of the queue.

Should be used only for cases, when message was dequeued and it’s execution should be postponed until the next block.

Object Safety

This trait is not object safe.

Implementors

impl<T, OutputError, KeyGen> Queue for QueueImpl<T, OutputError, KeyGen>

where T: Dequeue, OutputError: From<T::Error>, T::Error: DequeueError, KeyGen: KeyFor<Key = T::Key, Value = T::Value>,

type Value = <T as Dequeue>::Value

type Error = <T as Dequeue>::Error

type OutputError = OutputError