|
| 1 | +#`arraydeque` |
| 2 | + |
| 3 | +A circular buffer with fixed capacity. Requires Rust 1.12+. |
| 4 | + |
| 5 | +This crate is inspired by [**bluss/arrayvec**] |
| 6 | + |
| 7 | +[**bluss/arrayvec**]: https://github.com/bluss/arrayvec |
| 8 | + |
| 9 | +## Feature Flags |
| 10 | + |
| 11 | +The **arraydeque** crate has the following cargo feature flags: |
| 12 | + |
| 13 | +- `std` |
| 14 | + - Optional, enabled by default |
| 15 | + - Requires Rust 1.6 *to disable* |
| 16 | + - Use libstd |
| 17 | + |
| 18 | + |
| 19 | +- `use_union` |
| 20 | + - Optional |
| 21 | + - Requires Rust nightly channel |
| 22 | + - Use the unstable feature untagged unions for the internal implementation, |
| 23 | + which has reduced space overhead |
| 24 | + |
| 25 | + |
| 26 | +- `use_generic_array` |
| 27 | + - Optional |
| 28 | + - Requires Rust stable channel |
| 29 | + - Depend on generic-array and allow using it just like a fixed |
| 30 | + size array for ArrayVec storage. |
| 31 | + |
| 32 | + |
| 33 | +## Usage |
| 34 | + |
| 35 | +First, add the following to your `Cargo.toml`: |
| 36 | + |
| 37 | +```toml |
| 38 | +[dependencies] |
| 39 | +arraydeque = "0.1.2" |
| 40 | +``` |
| 41 | + |
| 42 | +Next, add this to your crate root: |
| 43 | + |
| 44 | +```rust |
| 45 | +extern crate arraydeque; |
| 46 | +``` |
| 47 | + |
| 48 | +Currently arraydeque by default links to the standard library, but if you would |
| 49 | +instead like to use arraydeque in a `#![no_std]` situation or crate you can |
| 50 | +request this via: |
| 51 | + |
| 52 | +```toml |
| 53 | +[dependencies] |
| 54 | +arraydeque = { version = "0.1.2", default-features = false } |
| 55 | +``` |
| 56 | + |
| 57 | +## Example |
| 58 | + |
| 59 | +### Push & Pop |
| 60 | + |
| 61 | +```rust |
| 62 | +extern crate arraydeque; |
| 63 | + |
| 64 | +use arraydeque::ArrayDeque; |
| 65 | + |
| 66 | +fn main() { |
| 67 | + let mut vector: ArrayDeque<[_; 8]> = ArrayDeque::new(); |
| 68 | + assert_eq!(vector.capacity(), 7); |
| 69 | + assert_eq!(vector.len(), 0); |
| 70 | + |
| 71 | + vector.push_back(1); |
| 72 | + vector.push_back(2); |
| 73 | + assert_eq!(vector.len(), 2); |
| 74 | + |
| 75 | + assert_eq!(vector.pop_front(), Some(1)); |
| 76 | + assert_eq!(vector.pop_front(), Some(2)); |
| 77 | + assert_eq!(vector.pop_front(), None); |
| 78 | +} |
| 79 | +``` |
| 80 | + |
| 81 | +### Insert & Remove |
| 82 | + |
| 83 | +```rust |
| 84 | +use arraydeque::ArrayDeque; |
| 85 | + |
| 86 | +let mut vector: ArrayDeque<[_; 8]> = ArrayDeque::new(); |
| 87 | + |
| 88 | +vector.push_back(11); |
| 89 | +vector.push_back(13); |
| 90 | +vector.insert(1, 12); |
| 91 | +vector.remove(0); |
| 92 | + |
| 93 | +assert_eq!(vector[0], 12); |
| 94 | +assert_eq!(vector[1], 13); |
| 95 | +``` |
| 96 | + |
| 97 | +### Append & Extend |
| 98 | + |
| 99 | +```rust |
| 100 | +use arraydeque::ArrayDeque; |
| 101 | + |
| 102 | +let mut vector: ArrayDeque<[_; 8]> = ArrayDeque::new(); |
| 103 | +let mut vector2: ArrayDeque<[_; 8]> = ArrayDeque::new(); |
| 104 | + |
| 105 | +vector.extend(0..5); |
| 106 | +vector2.extend(5..7); |
| 107 | + |
| 108 | +assert_eq!(format!("{:?}", vector), "[0, 1, 2, 3, 4]"); |
| 109 | +assert_eq!(format!("{:?}", vector2), "[5, 6]"); |
| 110 | + |
| 111 | +vector.append(&mut vector2); |
| 112 | + |
| 113 | +assert_eq!(format!("{:?}", vector), "[0, 1, 2, 3, 4, 5, 6]"); |
| 114 | +assert_eq!(format!("{:?}", vector2), "[]"); |
| 115 | +``` |
| 116 | + |
| 117 | +### Iterator |
| 118 | + |
| 119 | +```rust |
| 120 | +use arraydeque::ArrayDeque; |
| 121 | + |
| 122 | +let mut vector: ArrayDeque<[_; 8]> = ArrayDeque::new(); |
| 123 | + |
| 124 | +vector.extend(0..5); |
| 125 | + |
| 126 | +let iters: Vec<_> = vector.into_iter().collect(); |
| 127 | +assert_eq!(iters, vec![0, 1, 2, 3, 4]); |
| 128 | +``` |
| 129 | + |
| 130 | +### From Iterator |
| 131 | + |
| 132 | +```rust |
| 133 | +use arraydeque::ArrayDeque; |
| 134 | + |
| 135 | +let vector: ArrayDeque<[_; 8]>; |
| 136 | +let vector2: ArrayDeque<[_; 8]>; |
| 137 | + |
| 138 | +vector = vec![0, 1, 2, 3, 4].into_iter().collect(); |
| 139 | + |
| 140 | +vector2 = (0..5).into_iter().collect(); |
| 141 | + |
| 142 | +assert_eq!(vector, vector2); |
| 143 | +``` |
| 144 | + |
| 145 | +### Generic Array |
| 146 | + |
| 147 | +```toml |
| 148 | +[dependencies.arraydeque] |
| 149 | +version = "0.1.2" |
| 150 | +features = ["use_generic_array"] |
| 151 | +``` |
| 152 | +```rust |
| 153 | +#[macro_use] |
| 154 | +extern crate generic_array; |
| 155 | +extern crate arraydeque; |
| 156 | + |
| 157 | +use generic_array::GenericArray; |
| 158 | +use generic_array::typenum::U41; |
| 159 | + |
| 160 | +use arraydeque::ArrayDeque; |
| 161 | + |
| 162 | +fn main() { |
| 163 | + let mut vec: ArrayDeque<GenericArray<i32, U41>> = ArrayDeque::new(); |
| 164 | + |
| 165 | + assert_eq!(vec.len(), 0); |
| 166 | + assert_eq!(vec.capacity(), 40); |
| 167 | + |
| 168 | + vec.extend(0..20); |
| 169 | + |
| 170 | + assert_eq!(vec.len(), 20); |
| 171 | + assert_eq!(vec.into_iter().take(5).collect::<Vec<_>>(), vec![0, 1, 2, 3, 4]); |
| 172 | +} |
| 173 | +``` |
| 174 | + |
| 175 | +## Contribution |
| 176 | + |
| 177 | +All kinds of contribution are welcomed. |
| 178 | + |
| 179 | +- **Issus.** Feel free to open an issue when you find typos, bugs, or have any question. |
| 180 | +- **Pull requests**. New collection, better implementation, more tests, more documents and typo fixes are all welcomed. |
| 181 | + |
| 182 | +## License |
| 183 | + |
| 184 | +Licensed under MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) |
0 commit comments