ringbuffer
| Crates.io | ringbuffer |
| lib.rs | ringbuffer |
| version | 0.15.0 |
| source | src |
| created_at | 2019-06-25 12:43:45.256531 |
| updated_at | 2023-09-15 12:39:07.61207 |
| description | A fixed-size circular buffer |
| homepage | |
| repository | https://github.com/NULLx76/ringbuffer/ |
| max_upload_size | |
| id | 143482 |
| size | 118,210 |
Jonathan Dönszelmann (jdonszelmann)
documentation
README
Ringbuffer
The ringbuffer crate provides safe fixed size circular buffers (ringbuffers) in rust.
Implementations for three kinds of ringbuffers, with a mostly similar API are provided:
| type | description |
|---|---|
AllocRingBuffer |
Ringbuffer allocated on the heap at runtime. This ringbuffer is still fixed size. This requires the alloc feature. |
GrowableAllocRingBuffer |
Ringbuffer allocated on the heap at runtime. This ringbuffer can grow in size, and is implemented as an alloc::VecDeque internally. This requires the alloc feature. |
ConstGenericRingBuffer |
Ringbuffer which uses const generics to allocate on the stack. |
All of these ringbuffers also implement the RingBuffer trait for their shared API surface.
MSRV: Rust 1.59
Usage
use ringbuffer::{AllocRingBuffer, RingBuffer};
fn main() {
let mut buffer = AllocRingBuffer::with_capacity(2);
// First entry of the buffer is now 5.
buffer.push(5);
// The last item we pushed is 5
assert_eq!(buffer.back(), Some(&5));
// Second entry is now 42.
buffer.push(42);
assert_eq!(buffer.peek(), Some(&5));
assert!(buffer.is_full());
// Because capacity is reached the next push will be the first item of the buffer.
buffer.push(1);
assert_eq!(buffer.to_vec(), vec![42, 1]);
}
Features
| name | default | description |
|---|---|---|
| alloc | ✓ | Disable this feature to remove the dependency on alloc. Disabling this feature makes ringbuffer no_std. |
License
Licensed under MIT License