Struct crossbeam::queue::ArrayQueue [−][src]
pub struct ArrayQueue<T> { /* fields omitted */ }
Expand description
A bounded multi-producer multi-consumer queue.
This queue allocates a fixed-capacity buffer on construction, which is used to store pushed
elements. The queue cannot hold more elements than the buffer allows. Attempting to push an
element into a full queue will fail. Having a buffer allocated upfront makes this queue a bit
faster than SegQueue
.
Examples
use crossbeam_queue::ArrayQueue; let q = ArrayQueue::new(2); assert_eq!(q.push('a'), Ok(())); assert_eq!(q.push('b'), Ok(())); assert_eq!(q.push('c'), Err('c')); assert_eq!(q.pop(), Some('a'));
Implementations
impl<T> ArrayQueue<T>
[src]
impl<T> ArrayQueue<T>
[src]pub fn new(cap: usize) -> ArrayQueue<T>
[src]
pub fn new(cap: usize) -> ArrayQueue<T>
[src]pub fn push(&self, value: T) -> Result<(), T>
[src]
pub fn push(&self, value: T) -> Result<(), T>
[src]Attempts to push an element into the queue.
If the queue is full, the element is returned back as an error.
Examples
use crossbeam_queue::ArrayQueue; let q = ArrayQueue::new(1); assert_eq!(q.push(10), Ok(())); assert_eq!(q.push(20), Err(20));
pub fn pop(&self) -> Option<T>
[src]
pub fn pop(&self) -> Option<T>
[src]Attempts to pop an element from the queue.
If the queue is empty, None
is returned.
Examples
use crossbeam_queue::ArrayQueue; let q = ArrayQueue::new(1); assert_eq!(q.push(10), Ok(())); assert_eq!(q.pop(), Some(10)); assert!(q.pop().is_none());
pub fn capacity(&self) -> usize
[src]
pub fn capacity(&self) -> usize
[src]Returns the capacity of the queue.
Examples
use crossbeam_queue::ArrayQueue; let q = ArrayQueue::<i32>::new(100); assert_eq!(q.capacity(), 100);
pub fn is_empty(&self) -> bool
[src]
pub fn is_empty(&self) -> bool
[src]Returns true
if the queue is empty.
Examples
use crossbeam_queue::ArrayQueue; let q = ArrayQueue::new(100); assert!(q.is_empty()); q.push(1).unwrap(); assert!(!q.is_empty());
Trait Implementations
impl<T> Debug for ArrayQueue<T>
[src]
impl<T> Debug for ArrayQueue<T>
[src]impl<T> Drop for ArrayQueue<T>
[src]
impl<T> Drop for ArrayQueue<T>
[src]impl<T> Send for ArrayQueue<T> where
T: Send,
[src]
T: Send,
impl<T> Sync for ArrayQueue<T> where
T: Send,
[src]
T: Send,
Auto Trait Implementations
impl<T> !RefUnwindSafe for ArrayQueue<T>
impl<T> Unpin for ArrayQueue<T> where
T: Unpin,
T: Unpin,
impl<T> !UnwindSafe for ArrayQueue<T>
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Pointable for T
[src]
impl<T> Pointable for T
[src]