vrb_space_ptr(3)

💖 NAME 💖

okay so this is vrb_space_ptr(3) from the VRB Programmer's Manual, and its whole personality is: return pointer to empty space. that's the job. iconic. 🦋

📚 LIBRARY 📚

you'll be linking against -lvrb, bestie. no cap.

✨ SYNOPSIS ✨

#include <vrb.h>

size_t vrb_space_ptr(vrb_p vrb);

🌸 DESCRIPTION 🌸

vrb_space_ptr returns the pointer to the beginning of the contiguous block of empty space within the virtual ring buffer where data may be placed. the pointer has meaning only if there is space in the buffer.

⚠️ bestie, this is the important part: if there is no space in the buffer, an arbitrary pointer is returned that must not be used. use vrb_space_len(3) or vrb_is_full(3) to determine if vrb_space_ptr(3) has a meaningful pointer. 💅

the caller may access all of this space, and should call vrb_give(3) to indicate how much data has been placed into the buffer. periodt.

🎀 ARGUMENTS 🎀

• vrb_p vrb — specifies the virtual ring buffer to obtain the empty space pointer from. if a NULL or invalid pointer is given, results are unpredictable and are likely to be disasterous. like, genuinely do not do that. 😭

👑 RETURN VALUE 👑

• size_t — the pointer to the empty space in the virtual ring buffer is returned. that's what the page says, and we're keeping it exactly like that. 🫶

🔥 SEE ALSO 🔥

the whole friend group is here: vrb(3), vrb_capacity(3), vrb_data_len(3), vrb_data_ptr(3), vrb_destroy(3), vrb_get(3), vrb_get_min(3), vrb_give(3), vrb_init(3), vrb_init_opt(3), vrb_is_empty(3), vrb_is_full(3), vrb_is_not_empty(3), vrb_is_not_full(3), vrb_move(3), vrb_new(3), vrb_new_opt(3), vrb_put(3), vrb_put_all(3), vrb_read(3), vrb_read_min(3), vrb_resize(3), vrb_space_len(3), vrb_take(3), vrb_uninit(3), vrb_write(3), vrb_write_min(3).

xoxo, your Unix bestie 💅 — signed off by vrb / 2002-09-30 for vrb_space_ptr(3) 🫶✨