Crate swap_buffer_queue

swap-buffer-queue

A buffering MPSC queue.

This library is intended to be a (better, I hope) alternative to traditional MPSC queues in the context of a buffering consumer, by moving the buffering part directly into the queue.

It is especially well suited for IO writing workflow, see write and write_vectored.

The crate is no_std (some buffer implementations may require std).

In addition to the low level Queue implementation, a higher level SynchronizedQueue is provided with both blocking and asynchronous methods.

Examples

// Initialize the queue with a capacity
let queue: Queue<VecBuffer<usize>> = Queue::with_capacity(42);
// Enqueue some value
queue.try_enqueue([0]).unwrap();
// Multiple values can be enqueued at the same time
// (optimized compared to multiple enqueuing)
queue.try_enqueue([1, 2]).unwrap();
let mut values = vec![3, 4];
queue
    .try_enqueue(values.drain(..).into_value_iter())
    .unwrap();
// Dequeue a slice to the enqueued values
let slice = queue.try_dequeue().unwrap();
assert_eq!(slice.deref(), &[0, 1, 2, 3, 4]);
// Enqueued values can also be retrieved
assert_eq!(slice.into_iter().collect::<Vec<_>>(), vec![0, 1, 2, 3, 4]);

Modules

buffer

Buffer definition and simple implementations.

error

Queue error types.

notify

Tool for (a)synchronous implementation.

writewrite

Buffer implementations to be used with Write::write.

write_vectoredwrite and std

Buffer implementations to be used with Write::write_vectored.

Structs

Queue

A buffered MPSC “swap-buffer” queue.

SynchronizedNotifierstd

Synchronized (a)synchronous Notify implementation.

Type Aliases

SynchronizedQueuestd

Queue with SynchronizedNotifier