river-ring-buffer 0.4.0

A simple ring buffer implementation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

# River Ring Buffer

![Crates.io Version](https://img.shields.io/crates/v/river-ring-buffer)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/riverphillips/river-ring-buffer/rust.yml)
![Crates.io License](https://img.shields.io/crates/l/river-ring-buffer)

A simple ring buffer implemented in Rust.

A ring buffer is a high performant data structure that is great for buffering streams of data.

My motivation for building this was to understand ring buffers
as they're used extensively in new Linux Kernel feature such as eBPF and IO Uring.

## Example usage

``` Rust
    let mut buffer = RingBuffer::new(3);

    buffer.put(1)?;
    buffer.put(2)?;
    buffer.put(3)?;

    buffer.read(); // Returns Some(1)
```

An error is returned when the buffer is full.

```Rust
    let mut buffer = RingBuffer::new(3);

    buffer.put(1)?;
    buffer.put(2)?;
    buffer.put(3)?;
    buffer.put(4)?; // Returns Err("Buffer is full")   
```