buffer_get(3)

💖 buffer_get(3) 💖

okay bestie, welcome to the Library Functions Manual ✨ we're doing buffer_get today, she's the one who reads binary data out of a buffer, and she ATE 💅

---

🌸 NAME 🌸

buffer_get — read binary data from buffer 🦋

---

✨ SYNTAX ✨

#include <libowfat/buffer.h>

ssize_t buffer_get(buffer* b,char* x,size_t len);

like. that's it. that's the whole summoning circle 🎀

---

🫶 DESCRIPTION 🫶

so normally, buffer_get copies data to x[0], x[1], ..., x[len-1] from the beginning of a string stored in preallocated space. then it removes those len bytes from the string, and returns len. clean. iconic. no crumbs left behind 💅

BUT. and this is the plot twist 🍓 if the string has fewer than len bytes — but more than 0 — then buffer_get copies only that many bytes, and returns that number. so it gives you what it's got, ngl, it's doing its best 💜

and if the string is empty? buffer_get first uses a read operation to feed data into the string. that read operation can do two things:

1. it may indicate end of input — in which case buffer_get returns 0
2. or it may hit a read error — in which case buffer_get returns -1, and sets errno appropriately 😭

fr fr do not sleep on that -1. check your errno. it's giving "i tried my best and the world said no" 💀

the preallocated space and the read operation are specified by b. you must initialize b using buffer_init before calling buffer_get — or, alternatively, use the pre-initialized buffer_0 👑 (she comes ready-made, main character energy, no setup required 🌈)

lowkey important: buffer_init first or buffer_0, bestie. no uninitialized buffers in this house 🙈

---

👑 SEE ALSO 👑

• buffer_init(3)
• buffer_feed(3)
• buffer_peek(3)
• buffer_seek(3)
• buffer(3)

go read the whole squad, they're all slaying in their own way 💖

---

okay that's the page!! this one lives in the Library Functions Manual, and yeah the page is so iconic she literally signs her own name again at the bottom: buffer_get(3), periodt 💅✨ 🦋🎀💜