VecInitStack
- Macro
- August 22, 2025
Table of Contents
VecInitStack
VecInitStack
Description
Initialize given vector using memory from stack. Such vectors cannot be dynamically resized. Doing so is UB. It is mandatory to initialize vectors before use. Not doing so is undefined behaviour. These vectors are best used where user doesn’t get a chance to or does not want to deinit vector, given that no data in vector needs to be deinitialized. Example includes, but does not limit to a Vec(i8), Vec(f32), etc… Stack inited vectors mustn’t be deinited after use.
Parameters
Name | Direction | Description |
---|---|---|
v | in,out | Vector that needs to be initialized. |
ne | in | Number of elements to allocate stack memory for. |
Usage example (from documentation)
Vec(i32) ids;
VecInitStack(ids, 64, {
// scope where vector memory is available
ids = MakeClientRequestToFillVector(ids);
VecForeach(&ids, id, {
// some relevant logic
});
// Do not call deinit after use!!
});
Usage example (Cross-references)
- In
Init.h:116
:
/// FAILURE : NULL
///
#define StrInitStack(str, ne, scoped_body) VecInitStack(str, ne, scoped_body)
///
- In
Vec.Init.c:141
:
// Test vector stack initialization
bool test_vec_init_stack(void) {
printf("Testing VecInitStack\n");
bool result = true;
- In
Vec.Init.c:149
:
IntVec vec;
VecInitStack(vec, 10, {
// Inside the scope where the stack vector is valid
- In
Vec.Init.c:180
:
TestVec test_vec;
VecInitStack(test_vec, 5, {
// Inside the scope where the stack vector is valid