Implements an alterative to a Rust Vec that lives on the stack instead of on the heap, making creating it much faster.

The main type contributed is the StackVec, which has a Vec-like interface except for usage on the stack.

For example:

use stackvec::StackVec;

// Allocates space on the stack for 20 elements
let mut vec: StackVec<3, &str> = StackVec::new();
vec.push(" > Hello there!");
vec.push(" > General Kenobi, you are a bold one");
vec.push(" > Back away, I will deal with this Jedi slime myself");
println!("{}", vec.join("\n"));

If you allocate more than the reserved space, it does not automatically re-allocate like a Vec because it lives on the heap. Instead, it will panic:

use stackvec::StackVec;

// Allocates space on the stack for 20 elements
let mut vec: StackVec<3, &str> = StackVec::new();
vec.push("foo");
vec.push("bar");
vec.push("baz");
vec.push("quz");   // Panic: Cannot push 4th element to StackVec of capacity 3

Loosing this flexibility does mean a performance benefit because no allocation is needed:

(Benchmarks are averaged over 1,000,000,000 attempts with --release on an AMD Ryzen 7 PRO 5850U. See examples/benchmark.rs.)

To use the crate, simply add it as a dependency to your Cargo.toml:

[dependencies]
stackvec = { git = "https://github.com/Lut99/stackvec-rs" }

You can also commit to a specific tag by supplying it:

[dependencies]
stackvec = { git = "https://github.com/Lut99/stackvec-rs", tag = "v0.3.0" }

To inspect the code documentation, either use [rust-analyzer] to integrate the crate's documents into your IDE, or generate a standalone HTML:

cargo doc --no-deps --open

If you want to contribute to this crate, you can do so by raising an issue or creating a pull request. Note that this is a hobby project of mine, so responses may be slightly delayed.

This project is licensed under GPLv3. See LICENSE for more information.