Struct sigq::Queue

pub struct Queue<I> { /* fields omitted */ }

Implementations

impl<I> Queue<I>

pub fn new() -> Self

Create, and return, a new queue.

pub fn was_empty(&self) -> bool

Returns a boolean indicating whether the queue was empty or not.

This function is not particularly useful. If you don't understand why, then please don't use it.

pub fn push(&self, item: I)

Push a node on to the queue and unlock one queue reader, if any.

pub fn pop(&self) -> I

Pull the oldest node off the queue and return it. If no nodes are available on the queue, then block and wait for one to become available.

pub fn try_pop(&self) -> Option<I>

Pull the oldest node off the queue and return it. If no nodes are available on the queue, then return None.

pub fn apop(&self) -> PopFuture<I>

This method serves the same purpose as the pop() method, but rather than block it returns a Future to be used in an async context.

use sigq::Queue;
async fn test() {
  let q = Queue::new();
  q.push("hello".to_string());
  assert_eq!(q.was_empty(), false);
  let node = q.apop().await;
  assert_eq!(node, "hello");
  assert_eq!(q.was_empty(), true);
}