"combo_vec" is a library for creating a "combo stack array-heap vector", or simply a resizable array.
Create a new [ReArr
] with the [rearr!
] macro.
This works by allocating an array of T
on the stack, and then using a Vec on the heap for overflow.
The stack-allocated array is always used to store the first N
elements, even when the array is resized.
A quick look at a basic example and some methods that are available:
```rust use combo_vec::{rearr, ReArr};
let mut resizeablevec = rearr![1, 2, 3]; // Allocate an extra element on the heap resizeablevec.push(4); // Truncate to only the first 2 elements resizeablevec.truncate(2); // Fill the last element on the stack, then allocate the next two items on the heap resizeablevec.extend([3, 4, 5]); ```
You can allocate memory on the stack for later use without settings values to them!
No Copy or Default traits required.
```rust use combo_vec::{rearr, ReArr};
// Allocate a new, empty ReArr where no elements can be stored on the stack. // Not sure why you'd want to do this, but it's possible. let nostackf32vec = rearr![f32]; // Allocate a new, empty ReArr with 17 elements abled to be stored on the stack. let emptyf32_vec = rearr![f32; 17]; ```
The main benefit of using the [rearr!
] macro is that everything it does can be used in const contexts.
This allows you to allocate a ReArr at the start of your program in a Mutex or RwLock, and have minimal runtime overhead.
```rust use combo_vec::{rearr, ReArr};
const SOMEITEMS: ReArr
// Infer the type and size of the ReArr
const NOSTACKF32: ReArr
// No const-initialization is needed to create a ReArr with allocated elements on the stack
use std::collections::HashMap;
const EMPTYHASHMAPALLOC: ReArr
/// Create a global-state RwLock that can store a ReArr
use std::sync::RwLock;
static PROGRAM_STATE: RwLock