Struct SegQueue 

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

An unbounded multi-producer multi-consumer queue.

This queue is implemented as a linked list of segments, where each segment is a small buffer that can hold a handful of elements. There is no limit to how many elements can be in the queue at a time. However, since segments need to be dynamically allocated as elements get pushed, this queue is somewhat slower than ArrayQueue.

Examples

use crossbeam_queue::SegQueue;

let q = SegQueue::new();

q.push('a');
q.push('b');

assert_eq!(q.pop(), Some('a'));
assert_eq!(q.pop(), Some('b'));
assert!(q.pop().is_none());

Implementations

impl<T> SegQueue<T>

pub const fn new() -> SegQueue<T>

Creates a new unbounded queue.

Examples

use crossbeam_queue::SegQueue;

let q = SegQueue::<i32>::new();

pub fn push(&self, value: T)

Pushes back an element to the tail.

Examples

use crossbeam_queue::SegQueue;

let q = SegQueue::new();

q.push(10);
q.push(20);

pub fn push_mut(&mut self, value: T)

Pushes an element to the queue with exclusive mutable access.

Avoids atomic operations and synchronization, assuming no other threads access the queue concurrently.

Examples

use crossbeam_queue::SegQueue;

let mut q = SegQueue::new();

q.push_mut(10);
q.push_mut(20);

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

Pops the head element from the queue.

If the queue is empty, None is returned.

Examples

use crossbeam_queue::SegQueue;

let q = SegQueue::new();

q.push(10);
q.push(20);
assert_eq!(q.pop(), Some(10));
assert_eq!(q.pop(), Some(20));
assert!(q.pop().is_none());

pub fn pop_mut(&mut self) -> Option<T>

Pops the head element from the queue using an exclusive reference.

Avoids atomic operations and synchronization, assuming no other threads access the queue concurrently.

If the queue is empty, None is returned.

Examples

use crossbeam_queue::SegQueue;

let mut q = SegQueue::new();

q.push(10);
q.push(20);
assert_eq!(q.pop_mut(), Some(10));
assert_eq!(q.pop_mut(), Some(20));
assert!(q.pop_mut().is_none());

pub fn is_empty(&self) -> bool

Returns true if the queue is empty.

Examples

use crossbeam_queue::SegQueue;

let q = SegQueue::new();

assert!(q.is_empty());
q.push(1);
assert!(!q.is_empty());

pub fn len(&self) -> usize

Returns the number of elements in the queue.

Examples

use crossbeam_queue::SegQueue;

let q = SegQueue::new();
assert_eq!(q.len(), 0);

q.push(10);
assert_eq!(q.len(), 1);

q.push(20);
assert_eq!(q.len(), 2);

Trait Implementations

impl<T> Debug for SegQueue<T>

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

Formats the value using the given formatter.

impl<T> Default for SegQueue<T>

fn default() -> SegQueue<T>

Returns the “default value” for a type.

impl<T> Drop for SegQueue<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T> IntoIterator for SegQueue<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> RefUnwindSafe for SegQueue<T>

impl<T: Send> Send for SegQueue<T>

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

impl<T> UnwindSafe for SegQueue<T>