Crate ringbuffer

source ·
Expand description


Github Workflows

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:

AllocRingBufferRingbuffer allocated on the heap at runtime. This ringbuffer is still fixed size. This requires the alloc feature.
GrowableAllocRingBufferRingbuffer 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.
ConstGenericRingBufferRingbuffer 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


use ringbuffer::{AllocRingBuffer, RingBuffer};

fn main() {
    let mut buffer = AllocRingBuffer::with_capacity(2);

    // First entry of the buffer is now 5.

    // The last item we pushed is 5
    assert_eq!(buffer.back(), Some(&5));

    // Second entry is now 42.
    assert_eq!(buffer.peek(), Some(&5));

    // Because capacity is reached the next push will be the first item of the buffer.
    assert_eq!(buffer.to_vec(), vec![42, 1]);


allocDisable this feature to remove the dependency on alloc. Disabling this feature makes ringbuffer no_std.


Licensed under MIT License


  • The AllocRingBuffer is a RingBuffer which is based on a Vec. This means it allocates at runtime on the heap, and therefore needs the alloc crate. This struct and therefore the dependency on alloc can be disabled by disabling the alloc (default) feature.
  • The ConstGenericRingBuffer struct is a RingBuffer implementation which does not require alloc but uses const generics instead.
  • A growable ringbuffer. Once capacity is reached, the size is doubled. Wrapper of the built-in VecDeque struct.