Module yaque::queue

source ·
Expand description

Queue implementation and utility functions.

Structs

  • An Iterator that iterates over the elements of the queue, until it hts the end for the first time. Use this structure instead of crate::Receiver if you just need to read the data stored in a queue.
  • The receiver part of the queue. This part is asynchronous and therefore needs an executor that will the poll the futures to completion.
  • A builder for the receiver side of the queue. Use this if you want to have fine-grained control over the configuration of the queue. Most defaults should be ok of most applications.
  • A guard that will only log changes on the queue state when dropped.
  • The sender part of the queue. This part is lock-free and therefore can be used outside an asynchronous context.
  • A builder for the sender side of the queue. Use this if you want to have fine-grained control over the configuration of the queue. Most defaults should be ok of most applications.

Functions

  • Convenience function for opening the queue for both sending and receiving.
  • Deletes a queue at the given path. This function will await the queue to become available for both sending and receiving.
  • Tries to deletes a queue at the given path. This function will fail if the queue is in use either for sending or receiving.