Struct Queue

pub struct Queue<T: Serialize + DeserializeOwned> { /* private fields */ }

A FIFO queue Optionally has a server side time to live

Implementations

impl<T: Serialize + DeserializeOwned> Queue<T>

pub async fn push(&self, data: &T) -> Result<(), ErrorTypes>

enqueue a single item

pub async fn push_batch(&self, data: &[T]) -> Result<(), ErrorTypes>

enqueue a sequence of items

pub async fn unpop(&self, data: &T) -> Result<(), ErrorTypes>

Put all messages passed back at the head of the FIFO queue.

pub async fn length(&self) -> Result<usize, ErrorTypes>

Read the number of items in the queue

pub async fn peek_next(&self) -> Result<Option<T>, ErrorTypes>

load the item that would be returned by the next call to pop

pub async fn content(&self) -> Result<Vec<T>, ErrorTypes>

Load the entire content of the queue into memory

pub async fn delete(&self) -> Result<(), ErrorTypes>

Clear all data for this object

pub async fn pop(&self) -> Result<Option<T>, ErrorTypes>

dequeue an item from the front of the queue, returning immediately if empty

pub async fn pop_timeout( &self, timeout: Duration, ) -> Result<Option<T>, ErrorTypes>

Make a blocking pop call with a timeout

pub async fn pop_batch(&self, limit: usize) -> Result<Vec<T>, ErrorTypes>

Pop as many items as possible up to a certain limit

pub async fn select( queues: &[&Queue<T>], timeout: Option<Duration>, ) -> Result<Option<(String, T)>, ErrorTypes>

Wait for up to the given timeout for any of the given queues to recieve a value

pub fn raw(&self) -> RawQueue

access the untyped raw queue underlying the typed Queue object