#ring #circular #stack #deque #array

no-std arraydeque

A ring buffer with a fixed capacity, which can be stored on the stack

7 releases

0.4.5 Mar 20, 2019
0.4.4 Mar 6, 2019
0.4.3 Aug 28, 2018
0.4.2 Mar 3, 2018
0.1.3 Oct 31, 2016

#12 in No standard library

Download history 1649/week @ 2020-03-16 2502/week @ 2020-03-23 1933/week @ 2020-03-30 1525/week @ 2020-04-06 1745/week @ 2020-04-13 2361/week @ 2020-04-20 1716/week @ 2020-04-27 1906/week @ 2020-05-04 1751/week @ 2020-05-11 1661/week @ 2020-05-18 1749/week @ 2020-05-25 2090/week @ 2020-06-01 2088/week @ 2020-06-08 2410/week @ 2020-06-15 2098/week @ 2020-06-22 1600/week @ 2020-06-29

9,192 downloads per month
Used in 23 crates (19 directly)

MIT/Apache

110KB
2K SLoC

arraydeque

build status crates.io docs.rs

A circular buffer with fixed capacity. Requires Rust 1.20+.

This crate is inspired by bluss/arrayvec

Documentation

Usage

First, add the following to your Cargo.toml:

[dependencies]
arraydeque = "0.4"

Next, add this to your crate root:

extern crate arraydeque;

Currently arraydeque by default links to the standard library, but if you would instead like to use arraydeque in a #![no_std] situation or crate you can request this via:

[dependencies]
arraydeque = { version = "0.4", default-features = false }

Example

extern crate arraydeque;

use arraydeque::ArrayDeque;

fn main() {
    let mut deque: ArrayDeque<[_; 2]> = ArrayDeque::new();
    assert_eq!(deque.capacity(), 2);
    assert_eq!(deque.len(), 0);

    deque.push_back(1);
    deque.push_back(2);
    assert_eq!(deque.len(), 2);

    assert_eq!(deque.pop_front(), Some(1));
    assert_eq!(deque.pop_front(), Some(2));
    assert_eq!(deque.pop_front(), None);
}

Changelog

  • 0.4.5 Update generic-array to 0.12.

  • 0.4.4 Fix UB: Some(ArrayDeque::new(xs)).is_some() == false. (#12)

  • 0.4.3 Add support for generic-array under use_generic_array feature.

  • 0.4.1 Capacity now equal to backend_array.len().

  • 0.3.1 Add behaviors: Saturating and Wrapping.

Contribution

All kinds of contribution are welcomed.

  • Issus. Feel free to open an issue when you find typos, bugs, or have any question.
  • Pull requests. New collection, better implementation, more tests, more documents and typo fixes are all welcomed.

License

Licensed under MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

Dependencies

~37KB