SOLDOUT_BUFFER(3)

💖 SOLDOUT_BUFFER 💖

okay bestie, gather round 🫶 this is SOLDOUT_BUFFER(3) from the Library Functions Manual — literally the entire buffer-handling situation for soldout. it's giving "my strings need somewhere cute to live" and honestly? it ate. no cap. 💅

---

✨ NAME ✨

soldout_buffer, bufcasecmp, bufcmp, bufcmps, bufdup, bufgrow, bufnew, bufnullterm, bufprintf, bufput, bufputs, bufputc, bufrelease, bufreset, bufset, bufslurp, buftoi, vbufprintf — buffer handling functions for soldout 🌸

---

🎀 SYNOPSIS 🎀

#include <buffer.h>

#define CONST_BUF(name, string)
#define VOLATILE_BUF(name, strname)
#define BUFPUTSL(output, literal)

int
bufcasecmp(const struct buf *a, const struct buf *b);

int
bufcmp(const struct buf *a, const struct buf *b);

int
bufcmps(const struct buf *a, const char *b);

struct buf *
bufdup(const struct buf *src, size_t dupunit);

int
bufgrow(struct buf *buf, size_t sz);

struct buf *
bufnew(size_t unit);

void
bufnullterm(struct buf *buf);

void
bufprintf(struct buf *buf, const char *fmt, ...);

void
bufput(struct buf *buf, const void *data, size_t len);

void
bufputs(struct buf *buf, const char *str);

void
bufputc(struct buf *buf, char c);

void
bufrelease(struct buf *buf);

void
bufreset(struct buf *buf);

void
bufset(struct buf **dest, struct buf *src);

void
bufslurp(struct buf *buf, size_t len);

int
buftoi(struct buf *buf, size_t offset_i, size_t *offset_o);

void
vbufprintf(struct buf *buf, const char *fmt, va_list ap);

extern long buffer_stat_nb;
extern size_t buffer_stat_alloc_bytes;

---

🦋 DESCRIPTION 🦋

🌈 Variables

Compile time options. Statistics are kept about memory usage. 👀✨

• buffer_stat_nb — show how many buffers were created. she's counting, and she's keeping receipts 🧾
• buffer_stat_alloc_bytes — show how many bytes were allocated. the receipts, but in bytes 💾

🌸 Types

struct buf

character array buffer. Consists of the following fields:

• char * data — actual character data. the real ones ✨
• size_t size — size of the string. how much is actually in there 💅
• size_t asize — allocated size (0 = volatile buffer). how much room she booked 🎀
• size_t unit — reallocation unit size (0 = read-only buffer). how much she grows by when she needs more 🦋
• int ref — reference count. how many besties are holding onto her 🫶

🧚 Macros

• CONST_BUF — create a global buffer name from a string literal string. 🏛️
• VOLATILE_BUF — create a volatile buffer name on the stack from a string strname. 🫧
• BUFPUTSL — optimized bufputs() of a string literal. speed, but make it ✨aesthetic✨

👑 Functions

• bufcasecmp() — compare two buffers ignoring case. not judgmental, just lowercase about it 💅
• bufcmp() — compare two buffers. who's bigger, bestie 📏
• bufcmps() — compare a buffer to a string. buffer vs. the literal 😭
• bufdup() — duplicate a buffer src. twin energy, lowkey iconic 👯
• bufgrow() — increase the allocated size to the given value. glow-up, but measured in bytes 📈
• bufnew() — create a new buffer. brand new baby, periodt ⭐
• bufnullterm() — terminate the string array by NUL (making a C-string). closing the group chat properly 🔚
• bufprintf() — print formatted output to a buffer buf. formatted, so she's fancy 🎀
• bufput() — append raw data to a buffer buf. raw, unfiltered, no cap 🌶️
• bufputs() — append a NUL-terminated string str to a buffer buf. the classic move ✨
• bufputc() — append a single char c to a buffer buf. one little letter, main character energy 👑
• bufrelease() — decrease the reference count and free the buffer buf if needed. letting her go when nobody's holding on anymore 😭
• bufreset() — free internal data of the buffer buf. internal spring cleaning 🧹
• bufset() — safely assign a buffer to another. handoff, but safe, no drama 🫶
• bufslurp() — remove a given number of bytes from the head of the array. slurp 💀 bye bytes
• buftoi() — convert the numbers at the beginning of the buffer buf into an int. math era 🔢
• vbufprintf() — stdarg(3) variant of formatted printing into a buffer buf. the va_list cousin of bufprintf() 🌈

---

💅 RETURN VALUES 💅

the bufcasecmp(), bufcmp() and bufcmps() functions return an integer less than, equal to, or greater than zero if a is found, respectively, to be less than, to match, or be greater than b. yes, three outcomes, she's flexible 💖

the bufdup() and bufnew() functions return a struct buf * on success; on error they return NULL. 🌧️

the bufgrow() function returns on success 1; on error - 0. that's the whole vibe check ✅

the bufnullterm(), bufprintf(), bufput(), bufputs(), bufputc(), bufrelease(), bufreset(), bufset(), bufslurp() and vbufprintf() functions do not return a value. they just do the thing and leave 🫥✨

the buftoi() function return the converted value. yes, "return", singular, we don't argue with the original 🫶

---

🔥 SEE ALSO 🔥

soldout(3), stdarg(3) — go read those too bestie, iykyk 📚💜

---

🍓 AUTHORS 🍓

the soldout library was written by Natasha "Kerensikova" Porte <natacha@instinctive.eu>. 💖

manual page was originally written by Massimo Manghi <mxmanghi@apache.org>, and rewritten to mdoc format by Svyatoslav Mishyn <juef@openmailbox.org>. 🎀

---

and that's the whole page, bestie 💅 this one shipped from Debian on April 13, 2016, and it's SOLDOUT_BUFFER(3) forever and always. slay, stay buffered, drink water 🦋💖✨