# [−][src]Struct crossbeam_queue::ArrayQueue

    pub struct ArrayQueue<T> { /* fields omitted */ }

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 that 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, PushError};

    let q = ArrayQueue::new(2);

    assert_eq!(q.push('a'), Ok(()));
    assert_eq!(q.push('b'), Ok(()));
    assert_eq!(q.push('c'), Err(PushError('c')));
    assert_eq!(q.pop(), Ok('a'));

## Methods

### `impl<T> ArrayQueue<T>`[src]

#### `pub fn new(cap: usize) -> ArrayQueue<T>`[src]

Creates a new bounded queue with the given capacity.

# Panics

Panics if the capacity is zero.

# Examples

    use crossbeam_queue::ArrayQueue;

    let q = ArrayQueue::<i32>::new(100);

#### `pub fn push(&self, value: T) -> Result<(), PushError<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, PushError};

    let q = ArrayQueue::new(1);

    assert_eq!(q.push(10), Ok(()));
    assert_eq!(q.push(20), Err(PushError(20)));

#### `pub fn pop(&self) -> Result<T, PopError>`[src]

Attempts to pop an element from the queue.

If the queue is empty, an error is returned.

# Examples

    use crossbeam_queue::{ArrayQueue, PopError};

    let q = ArrayQueue::new(1);
    assert_eq!(q.push(10), Ok(()));

    assert_eq!(q.pop(), Ok(10));
    assert_eq!(q.pop(), Err(PopError));

#### `pub fn capacity(&self) -> usize`[src]

Returns the capacity of the queue.

# Examples

    use crossbeam_queue::{ArrayQueue, PopError};

    let q = ArrayQueue::<i32>::new(100);

    assert_eq!(q.capacity(), 100);

#### `pub fn is_empty(&self) -> bool`[src]

Returns `true` if the queue is empty.

# Examples

    use crossbeam_queue::{ArrayQueue, PopError};

    let q = ArrayQueue::new(100);

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

#### `pub fn is_full(&self) -> bool`[src]

Returns `true` if the queue is full.

# Examples

    use crossbeam_queue::{ArrayQueue, PopError};

    let q = ArrayQueue::new(1);

    assert!(!q.is_full());
    q.push(1).unwrap();
    assert!(q.is_full());

#### `pub fn len(&self) -> usize`[src]

Returns the number of elements in the queue.

# Examples

    use crossbeam_queue::{ArrayQueue, PopError};

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

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

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

## Trait Implementations

### `impl<T: Send> Send for ArrayQueue<T>`[src]

### `impl<T> Drop for ArrayQueue<T>`[src]

#### `fn drop(&mut self)`[src]

Executes the destructor for this type. Read more

### `impl<T: Send> Sync for ArrayQueue<T>`[src]

### `impl<T> Debug for ArrayQueue<T>`[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

### `impl<T> Unpin for ArrayQueue<T> where
T: Unpin,`

### `impl<T> !UnwindSafe for ArrayQueue<T>`

### `impl<T> !RefUnwindSafe for ArrayQueue<T>`

## Blanket Implementations

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)