Circular Buffer for Rust

This is a Rust crate that implements a circular buffer, also known as cyclic buffer, circular queue or ring.

A circular buffer has a maximum capacity, does not automatically grow, and once its maximum capacity is reached, elements at the start of the buffer are overwritten. It's useful for implementing fast FIFO (first in, first out) and LIFO (last in, first out) queues with a fixed memory capacity.

This crate comes with three main structs:

1. FixedCircularBuffer: this has a fixed capacity that is specified at compile-time and can live on the stack. It is conceptually similar to an array.
2. HeapCircularBuffer: this is a heap-allocated struct, with dynamic capacity that is specified at runtime. It is conceptually similar to a Vec.
3. CircularBuffer: this is a view of the elements of either a FixedCircularBuffer or a HeapCircularBuffer. It is conceptually similar to a slice.

For more information and examples, check out the documentation!

Changelog

For a full list of changes between releases, visit GitHub.

Example

use circular_buffer::FixedCircularBuffer;

// Initialize a new, empty circular buffer with a capacity of 5 elements
let mut buf = FixedCircularBuffer::<u32, 5>::new();

// Add a few elements
buf.push_back(1);
buf.push_back(2);
buf.push_back(3);
assert_eq!(buf, [1, 2, 3]);

// Add more elements to fill the buffer capacity completely
buf.push_back(4);
buf.push_back(5);
assert_eq!(buf, [1, 2, 3, 4, 5]);

// Adding more elements than the buffer can contain causes the front elements to be
// automatically dropped
buf.push_back(6);
assert_eq!(buf, [2, 3, 4, 5, 6]); // `1` got dropped to make room for `6`