Struct LockFreeStack 

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

A lock-free LIFO stack (Treiber stack).

All operations (push, pop, peek_len) are lock-free and use compare-and-swap loops on the head pointer.

Example

use scirs2_core::distributed::lock_free::LockFreeStack;

let stack = LockFreeStack::new();
stack.push(1);
stack.push(2);
stack.push(3);

assert_eq!(stack.pop(), Some(3));
assert_eq!(stack.pop(), Some(2));
assert_eq!(stack.pop(), Some(1));
assert_eq!(stack.pop(), None);

Implementations

impl<T> LockFreeStack<T>

pub fn new() -> Self

Create a new empty lock-free stack.

pub fn push(&self, value: T)

Push a value onto the top of the stack.

This operation is lock-free and will succeed even under contention.

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

Pop the top value from the stack, or return None if empty.

This operation is lock-free.

pub fn is_empty(&self) -> bool

Returns true if the stack is empty.

Note: due to concurrent operations, the result may be stale by the time it is observed.

pub fn len(&self) -> usize

Approximate number of elements in the stack.

This is an approximation because concurrent push/pop operations may be in progress.

Trait Implementations

impl<T: Debug> Debug for LockFreeStack<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Default for LockFreeStack<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Drop for LockFreeStack<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Send> Send for LockFreeStack<T>

impl<T: Send> Sync for LockFreeStack<T>