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

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§

source§

impl<T> SegQueue<T>

source

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

Creates a new unbounded queue.

Examples
use crossbeam_queue::SegQueue;

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

pub fn push(&self, value: T)

Pushes an element into the queue.

Examples
use crossbeam_queue::SegQueue;

let q = SegQueue::new();

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

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

Pops an element from the queue.

If the queue is empty, None is returned.

Examples
use crossbeam_queue::SegQueue;

let q = SegQueue::new();

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

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());
source

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§

source§

impl<T> Debug for SegQueue<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> Default for SegQueue<T>

source§

fn default() -> SegQueue<T>

Returns the “default value” for a type. Read more
source§

impl<T> Drop for SegQueue<T>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

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?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<T> RefUnwindSafe for SegQueue<T>

source§

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

source§

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

source§

impl<T> UnwindSafe for SegQueue<T>

Auto Trait Implementations§

§

impl<T> Unpin for SegQueue<T>
where T: Unpin,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.