MTREE_BUILD(3)

💖 MTREE_BUILD 💖

okay so bestie, welcome to the Librecast Programmer's Manual — this is mtree_build(3) and it's lowkey iconic. let's get into it ✨

---

🌸 NAME 🌸

mtree_build — build a merkle tree from base data

---

🎀 LIBRARY 🎀

Librecast library (liblibrecast, -llibrecast)

---

✨ SYNOPSIS ✨

#include <librecast/mtree.h>

int mtree_build(mtree_t *tree, void * const data, q_t *q);

Compile and link with -llibrecast.

---

🦋 DESCRIPTION 🦋

so the mtree_build function builds a merkle tree — that's the tree — and no, you can't just show up with an empty vibe, it has to have been previously initialized with mtree_init(3) first. the base data it's building from is the stuff pointed to by data. periodt.

now, the q situation, listen up:

• if q is not NULL, it must point to a queue q_t structure that was previously initialized with q_init(3). this queue is gonna have jobs enqueued to it to build the tree. normally you'd pair this with a threadpool created with q_pool_create(3), where the threads are all calling q_job_seek(3). that's the whole squad working together, main character energy fr fr 🔥
• if q is NULL, then the creation and destruction of a queue and threadpool gets handled automatically for you. no cap, it just does it. you don't have to lift a finger 💅

---

🌈 RETURN VALUE 🌈

okay so here's the tea:

• mtree_init() returns zero on success. on error, -1 is returned, and errno is set to indicate the error.
• the mtree_free() function returns no value, and preserves errno.

and yes bestie, the return value section really is out here talking about mtree_init() and mtree_free() — that's literally what the page says, iykyk 🙈

---

💀 ERRORS 💀

TODO

(yeah. that's it. that's the whole section. we love a mystery 🫶)

---

😭 BUGS 😭

No error handling.

not me reading that and going 💀 — that's verbatim what the manpage says, bestie. it's giving "we'll deal with it later" and honestly? relatable.

---

🍓 EXAMPLE 🍓

TODO

(it's giving unfinished homework but we move ✨)

---

⭐ SEE ALSO ⭐

• mtree_init(3)
• mtree_free(3)
• q_init(3)
• q_pool_create(3)
• q_job_seek(3)

---

👑 SIGN-OFF 👑

and that's the whole page, bestie!! this lil masterpiece is from the LIBRECAST era, dated 2023-06-20, and it's page MTREE_BUILD(3) of the Librecast Programmer's Manual. go build that merkle tree, you absolute legend 🧚💜🌸