Trait MessageQueue

pub trait MessageQueue<Message: Send>: Backend<Request<Message, Self::Context>> {
    type Context: Default;
    type Error;
    type Compact;

    // Required methods
    fn enqueue_request(
        &mut self,
        req: Request<Message, Self::Context>,
    ) -> impl Future<Output = Result<(), Self::Error>> + Send;
    fn enqueue_raw_request(
        &mut self,
        req: Request<Self::Compact, Self::Context>,
    ) -> impl Future<Output = Result<(), Self::Error>> + Send;
    fn dequeue_request(
        &mut self,
    ) -> impl Future<Output = Result<Option<Request<Message, Self::Context>>, Self::Error>> + Send;
    fn size(
        &mut self,
    ) -> impl Future<Output = Result<usize, Self::Error>> + Send;

    // Provided methods
    fn enqueue(
        &mut self,
        message: Message,
    ) -> impl Future<Output = Result<(), Self::Error>> + Send { ... }
    fn dequeue(
        &mut self,
    ) -> impl Future<Output = Result<Option<Message>, Self::Error>> + Send { ... }
}

Represents a message queue that can be pushed and consumed.

Required Associated Types

type Context: Default

This stores more data about the Message, provided by the backend

type Error

The error produced by the queue

type Compact

The format that the storage persists the jobs usually Vec<u8>

Required Methods

fn enqueue_request( &mut self, req: Request<Message, Self::Context>, ) -> impl Future<Output = Result<(), Self::Error>> + Send

Enqueues a Request constructed with customizations

fn enqueue_raw_request( &mut self, req: Request<Self::Compact, Self::Context>, ) -> impl Future<Output = Result<(), Self::Error>> + Send

Enqueues a request without forcing the type

fn dequeue_request( &mut self, ) -> impl Future<Output = Result<Option<Request<Message, Self::Context>>, Self::Error>> + Send

Attempts to dequeue a message from the queue. Returns None if the queue is empty.

fn size(&mut self) -> impl Future<Output = Result<usize, Self::Error>> + Send

Returns the current size of the queue.

Provided Methods

fn enqueue( &mut self, message: Message, ) -> impl Future<Output = Result<(), Self::Error>> + Send

Enqueues a message to the queue.

fn dequeue( &mut self, ) -> impl Future<Output = Result<Option<Message>, Self::Error>> + Send

Attempts to dequeue a message from the queue. Returns None if the queue is empty.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<Message: Send + 'static + Sync> MessageQueue<Message> for MemoryStorage<Message>

type Context = ()

type Error = ()

type Compact = Message