Trait NetQueue

pub trait NetQueue<Item> {
    type KeyId;
    type Error;

    // Required methods
    fn insert(
        &mut self,
        item: Item,
    ) -> Result<Self::KeyId, NetQueueError<Self::Error>>;
    fn remove(
        &mut self,
        key: Self::KeyId,
    ) -> Result<Item, NetQueueError<Self::Error>>;
    fn get(
        &mut self,
        key: Self::KeyId,
    ) -> Result<&Item, NetQueueError<Self::Error>>;
    fn flush(&mut self) -> Result<Vec<Item>, NetQueueError<Self::Error>>;
}

Required Associated Types

type KeyId

The Item of the queue. The “key” that each Item is stored under (used for removal)

type Error

A custom error specifier for NetQueueError

Required Methods

fn insert( &mut self, item: Item, ) -> Result<Self::KeyId, NetQueueError<Self::Error>>

Inserts Item into the queue, given the conditions are fulfilled.

fn remove( &mut self, key: Self::KeyId, ) -> Result<Item, NetQueueError<Self::Error>>

Remove an Item from the queue by providing an instance of Self::KeyId

fn get(&mut self, key: Self::KeyId) -> Result<&Item, NetQueueError<Self::Error>>

Retrieves an Item from the queue, by reference.

fn flush(&mut self) -> Result<Vec<Item>, NetQueueError<Self::Error>>

Clears the entire queue.

Implementors

impl<Item> NetQueue<Item> for RecoveryQueue<Item>

type KeyId = u32

type Error = ()