apalis_core/mq/
mod.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
//! # Message queue
//!
//! The `mq` module provides an abstraction for representing a message queue that supports pushing and consuming messages. It defines the MessageQueue trait, which can be implemented by different types of message queues.

use futures::Future;

/// Represents a message queue that can be pushed and consumed.
pub trait MessageQueue<Message> {
    /// The error produced by the queue
    type Error;

    /// Enqueues a message to the queue.
    fn enqueue(&mut self, message: Message)
        -> impl Future<Output = Result<(), Self::Error>> + Send;

    /// Attempts to dequeue a message from the queue.
    /// Returns `None` if the queue is empty.
    fn dequeue(&mut self) -> impl Future<Output = Result<Option<Message>, Self::Error>> + Send;

    /// Returns the current size of the queue.
    fn size(&mut self) -> impl Future<Output = Result<usize, Self::Error>> + Send;
}