This is the simplest and the fastest (faster than Vec!) implementation of a last-in-first-out stack data structure, on stack, when stack elements are Copy implementing primitives. This is basically a wrapper around an uninitialized array. When it is created on stack, its elements contain no specific data. Then, when you push_unchecked(x), the head of the stack is moved forward and x is placed into the element of the array. When you pop_unchecked(), the head is moved backward and the data is retrieved from the array. There are no boundary checks, that's why both push_unchecked() and pop_unchecked() may lead to undefined behavior. Use push() and pop(), which are safer, but slower. For even slower but even safer behavior, you can use try_push() and try_pop().
First, add this to Cargo.toml:
[dependencies]
microstack = "0.0.7"
Then, use it like this (mind the unsafe blocks, they give the fastest performance, but undefined behavior if you go over the stack boundaries):
use microstack::Stack;
let mut s : Stack<&str, 10> = Stack::new(); // allocation on stack
unsafe { s.push_unchecked("foo") }; // no boundary checks here
unsafe { s.push_unchecked("bar") }; // and here
assert_eq!("bar", unsafe { s.pop_unchecked() }); // and here again
assert_eq!(1, s.len());
Pay attention, here the stack is created with an extra const generic argument equal to 10. This is the total size of the stack data structure, which is allocated on stack when ::new() is called.
Read the API documentation.
How to Contribute
First, install Rust and then:
$ cargo test -vv
If everything goes well, fork repository, make changes, send us a pull request. We will review your changes and apply them to the master branch shortly, provided they don't violate our quality standards. To avoid frustration, before sending us your pull request please run cargo test again. Also, run cargo fmt and cargo clippy.
Also, before you start making changes, run benchmarks:
$ rustup run nightly cargo bench
Then, after the changes you make, run it again. Compare the results. If your changes degrade performance, think twice before submitting a pull request.
5 Aug 16, 2022
2 Oct 26, 2021
97 Apr 8, 2023
6 Aug 14, 2022
9 Nov 30, 2022
47 Mar 19, 2024
5 Aug 6, 2023
131 Dec 27, 2022
11 Nov 1, 2022
10 May 31, 2022
51 Oct 4, 2023
1 Jan 28, 2022
11 Dec 31, 2022
6 Apr 11, 2022
40 Dec 28, 2022
39 Aug 28, 2022
169 Apr 7, 2023
11 Dec 19, 2021