hoop

Crates.iohoop
lib.rshoop
version0.2.8
sourcesrc
created_at2018-02-12 23:46:32.450949
updated_at2018-02-17 03:09:58.435343
descriptionFixed ring buffer that allows non-consuming iteration both ways
homepagehttps://github.com/gnzlbg/slice_deque
repositoryhttps://github.com/andoriyu/hoop
max_upload_size
id50934
size22,401
Andrey Snow (andoriyu)

documentation

README

Hoop

Build Status codecov Crates.io

Very naive and probably non-perfomant implementation of fixed size circular buffer. The only difference between that one and the many others is: this one has double ended non-consuming iterator support.

Why?

Imagine you have some metrics data coming in and you need to aggregate over it and at msot you have to go 21 items deep. With Vec and VecDeque you will keep moving and/or allocationg things. This buffer allows you to simple keep writting to it and from time to time grab "Last N items" without removing it from buffer.

Installation

hoop is available on crates.io and can be included in your Cargo enabled project like this:

[dependencies]
hoop = "0.2.7"

Usage

let mut buffer = Hoop::with_capacity(4);
buffer.write('1');
buffer.write('2');
buffer.write('3');
buffer.write('4');
let mut iter = buffer.iter();
assert_eq!(Some(&'1'), iter.next());
assert_eq!(Some(&'4'), iter.next_back());
assert_eq!(Some(&'2'), iter.next());
assert_eq!(Some(&'3'), iter.next_back());
assert_eq!(None, iter.next());
assert_eq!(None, iter.next_back());
Commit count: 10

cargo fmt