Struct RcuQueue

pub struct RcuQueue<T, F = RcuDefaultFlavor> { /* private fields */ }

Defines a RCU wait-free queue.

This queue supports multiple concurrents readers and writers. It is guaranteed to never block on a call.

Limitations

References

This queue currently do not offer a way to peek the back or front of the queue. It is also currently not possible to iterate over the queue. Because of this, it is impossible to get any sort of references. The only way to get data is to remove it from the queue with RcuQueue::pop.

Safety

It is safe to send an Arc<RcuQueue<T>> to a non-registered RCU thread. A non-registered thread may drop an RcuQueue<T> without calling any RCU primitives since lifetime rules prevent any other thread from accessing a RCU reference.

Implementations

impl<T, F> RcuQueue<T, F>

where F: RcuFlavor,

pub fn new() -> Arc<Self>

Creates a new RCU queue.

pub fn push<G>(&self, data: T, _guard: &G)

where T: Send, G: RcuGuard<Flavor = F>,

Adds an element to the back of queue.

pub fn pop<G>(&self, _guard: &G) -> Option<Ref<T, F>>

where T: Send, G: RcuGuard<Flavor = F>,

Removes an element to the front of the queue, if any.

Trait Implementations

impl<T, F> Drop for RcuQueue<T, F>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, F> Send for RcuQueue<T, F>

where T: Send, F: RcuFlavor,

Safety

An RcuQueue can be used to send T to another thread.

impl<T, F> Sync for RcuQueue<T, F>

where T: Sync, F: RcuFlavor,

Safety

An RcuQueue can be used to share T between threads.