array(3)

💖 array(3) — the array library interface 💖

okay bestie, welcome to the array(3) page, straight outta the Library Functions Manual ✨ this is the whole array library interface and honestly? it's giving organized. it's giving memory-safe girlboss. let's go 🫶

---

🌸 NAME 🌸

array — The array library interface 💅

---

✨ SYNTAX ✨

#include <libowfat/array.h>

like literally just include it and you're in, no cap 🎀

---

🦋 DESCRIPTION 🦋

so an allocated array variable is keeping track of three things at all times, and she's tracking them obsessively:

• a (nonzero) pointer to a dynamically allocated region of memory 💾
• the number of bytes allocated (always positive, periodt) 📏
• and the number of bytes initialized (which lives somewhere between 0 and the number of bytes allocated) ✅

there are two other possibilities for the state of an array variable, and they're the sad ones: unallocated and failed 😭 in both of those cases there is no dynamically allocated region of memory. none. zero. the void.

a new array variable is normally created as a static variable, like so:

#include <libowfat/array.h>

static array x;

at this point it's unallocated — just a baby, no memory yet 🙈 the array library provides various allocation and inspection functions to fix that.

a new array variable can also be created dynamically 🌀 but listen, this is important: it must be initialized to all-0, meaning unallocated, before it is given to any of the array functions. and it must be returned to the unallocated (or failed) state — for example with array_reset — before it is destroyed. these rules prevent all memory leaks 🧚 and memory leaks are not the vibe.

🔍 Expansion and inspection 🔍

array x;

t* p1 = array_allocate(&x,sizeof(t),pos);

t* p2 = array_get(&x,sizeof(t),pos);

t* p3 = array_start(&x);

int64 len = array_length(&x,sizeof(t));

int64 bytes = array_bytes(&x);

✂️ Truncation and deallocation ✂️

array x;

array_truncate(&x,sizeof(t),len);

array_trunc(&x);

array_reset(&x);

array_fail(&x);

⚖️ Comparison ⚖️

array x;
array y;

if (array_equal(&x,&y))
  /* arrays are equal... */

🧩 Concatenation 🧩

array x;
array y;

array_cat(&x,&y);

array_catb(&x,"fnord",5);

array_cats(&x,"fnord");

array_cats0(&x,"fnord"); /* also append the \0 */

array_cat0(&x); /* append \0 */

array_cate(&x,"fnord",1,4); /* append "nor" */

---

📜 ORIGINAL API DEFINITION 📜

http://cr.yp.to/lib/array.html

---

👑 SEE ALSO 👑

array_get(3), array_start(3), array_fail(3)

---

and that's the whole page bestie 💖 this was array(3) from the Library Functions Manual — go forth and allocate responsibly, return everything to unallocated before it's destroyed, and remember: no leaks, only slay 💅✨🎀🦋