ringvec 0.1.0

A simple ring buffer implementation based on a vector
Documentation
  • Coverage
  • 0%
    0 out of 14 items documented0 out of 13 items with examples
  • Size
  • Source code size: 25.71 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 2.31 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 10s Average build duration of successful builds.
  • all releases: 10s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • stjepangolemac/ringvec
    0 0 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • stjepangolemac

ringvec

License

A simple ring buffer implementation based on a vector. No dependencies except criterion for benchmarking.

Usage

use ringvec::RingVec;

fn main() {
    let mut v = RingVec::new(3);

    assert!(v.is_empty());
    assert!(!v.is_full());

    v.push(1);
    v.push(2);
    v.push(3);

    v.push_force(4);
    v.push_force(5);

    assert!(!v.is_empty());
    assert!(v.is_full());

    assert_eq!(v.peek_oldest(), Some(&3));
    assert_eq!(v.peek_newest(), Some(&5));

    assert_eq!(v.pop(), Some(3));

    assert!(!v.is_empty());
    assert!(!v.is_full());

    assert_eq!(v.pop(), Some(4));
    assert_eq!(v.pop(), Some(5));

    assert!(v.is_empty());
    assert!(!v.is_full());
}

Performance

It's optimized for peeking, but not slow when pushing too. I might've messed something up when it comes to benchmarking peeking.

  • push 7.4ns
  • peek oldest 0ns
  • peek newest 0ns