#circular-buffer #ring-buffer #stack #tiny #push

ringstack

A very simple circular buffered stack implementation

3 unstable releases

0.2.0 Sep 4, 2023
0.1.1 Nov 13, 2022
0.1.0 Nov 13, 2022

#1192 in Algorithms

Download history 25/week @ 2024-04-14 49/week @ 2024-04-21 9/week @ 2024-04-28 15/week @ 2024-05-05 47/week @ 2024-05-12 54/week @ 2024-05-19 120/week @ 2024-05-26 66/week @ 2024-06-02 45/week @ 2024-06-09 96/week @ 2024-06-16 77/week @ 2024-06-23 10/week @ 2024-06-30 23/week @ 2024-07-07 34/week @ 2024-07-14 28/week @ 2024-07-21 74/week @ 2024-07-28

160 downloads per month

MIT license

12KB
216 lines

ringstack

ringstack

[RingStack] is a tiny stack implementation which uses circular buffer.

Since [RingStack] is constructed upon a circular buffer, the oldest item automatically dropped as you [push][RingStack::push()] when the number of items has already reached its limit. (Thus [len][RingStack::len()] method saturate with that number of limit.)

And it supports [RingStack::iter()] method which returns Iterator<&T>. It provides items one by one with historical order, latest to oldest.

Though [RingStack] currently uses [Vec] as its internals, once it allocates at the timing of [new][RingStack::new()] then additional allocation never happends.

Examples

use ringstack::RingStack;

let mut s = RingStack::<i32, 3>::new();
assert_eq!(s.peek(), None);

s.push(1);
s.push(2);
assert_eq!(s.peek(), Some(&2));
assert_eq!(s.pop(), Some(2));
assert_eq!(s[0], 1);
assert_eq!(s.get(0), Some(&1));
assert_eq!(s.get(1), None);

s.push(3);
s.push(4);
let v: Vec<i32> = s.iter().map(|e| e.clone()).collect();
assert_eq!(v, vec![4, 3, 1]);

s.push(5);
let v: Vec<i32> = s.iter().map(|e| e.clone()).collect();
assert_eq!(v, vec![5, 4, 3]);

assert_eq!(s.pop(), Some(5));
assert_eq!(s.pop(), Some(4));
assert_eq!(s.pop(), Some(3));
assert_eq!(s.pop(), None);

Changelog

0.2.0

  • Added [len()], [get()] methods.

  • Implemented std::ops::Index.

  • Change [iter()] return type

    Changed from &Option<T> into &T and it iterates only valid elements, since it returns reference of T not Option.

0.1.1

Make RingStack [Debug] derived

0.1.0

Initial Version

License

The MIT License (MIT)

Copyright (c) 2022 msr1k

No runtime deps