Struct atomic_queue::Queue

pub struct Queue<T> { /* private fields */ }

Atomic queue cloned from https://github.com/max0x7ba/atomic_queue

Should be:

• Lock-free

Any type can be pushed into the queue, but it’s recommended to use some sort of smart pointer that can be free-ed outside of the critical path.

Uses unsafe internally.

Implementations

impl<T> Queue<T>

pub fn new(capacity: usize) -> Self

Create a queue with a certain capacity. Writes will fail when the queue is full.

pub fn push(&self, element: T) -> bool

Push an element into the queue and return true on success.

false will be returned if the queue is full. If there’s contention this operation will wait until it’s able to claim a slot in the queue.

This is a CAS loop to increment the head of the queue, then another to push this element in.

pub fn pop(&self) -> Option<T>

Pop an element from the queue and return true on success.

false will be returned if the queue is empty. If there’s contention this operation will wait until it’s able to claim a slot in the queue.

This is a CAS loop to increment the tail of the queue then another CAS loop to pop the element at this index out.

pub unsafe fn force_pop(&self) -> T

Pop an element from the queue without checking if it’s empty.

Safety

There’s nothing safe about this.

pub unsafe fn force_push(&self, element: T)

Push an element into the queue without checking if it’s full.

Safety

There’s nothing safe about this.

pub fn is_empty(&self) -> bool

True if the queue is empty.

pub fn len(&self) -> usize

Get the length of the queue.

Trait Implementations

impl<T: Send> Send for Queue<T>

impl<T> Sync for Queue<T>