BSON_READER_NEW_FROM_HANDLE(3)

📦
version 2.5.6 · 16 versions
, in epel 10

💅 BSON_READER_NEW_FROM_HANDLE — like, the libbson girlies are gonna eat this one up

okay so bestie, welcome to bson_reader_new_from_handle(3) from libbson, the manual page you didn't know you needed until right now. this is the one where you get to plug your own stream into the reader. main character energy, fr fr. 🎀

✨ SYNOPSIS ✨

bson_reader_t *
bson_reader_new_from_handle (void *handle,
                             bson_reader_read_func_t rf,
                             bson_reader_destroy_func_t df);

literally just three little args and you get a whole reader back. the way that this signature is so clean?? obsessed. 🌸

🫶 PARAMETERS 🫶

  • handle — a user-provided pointer, or NULL if you're feeling mysterious. your call, queen. (yes, NULL is allowed, it says so right there 👑)
  • rf — a bson_reader_read_func_t. this is the read function, the vibe of the operation.
  • df — a bson_reader_destroy_func_t. this is the cleanup function, holding it down at the end. 🧹

🦋 DESCRIPTION 🦋

so here's the tea: this function lets you have a pluggable data stream for the reader. pluggable!! like you can swap the source out and the reader is just fine with it. it's giving "open relationship with your file descriptors." 💀

what can you read from, you ask? sockets, files, memory, or other arbitrary sources. yes, arbitrary. go off, honestly. 🌈

basically if you've got data coming from somewhere and you've got a read func and a destroy func, this is the constructor for you. no cap. 🔥

ngl this is highkey the move when your stream doesn't fit the built-in file/memory helpers — you bring the functions, libbson brings the reader. 💜

⭐ RETURNS ⭐

a newly allocated bson_reader_t if successful; otherwise NULL. 😭

so like, check it. if you get NULL, something went sideways, and you should probably not keep dereferencing things. ask me how I know. 🙈

👑 AUTHOR 👑

MongoDB, Inc — the icons themselves. 💅

2009-present, MongoDB, Inc. — yes, they've been at this since 2009 and the copyright still says present, iconic behaviour honestly.

and that's the whole page, bestie!! 🥳 no notes, 10/10, would read again.

signing off from libbson 2.5.6, dated Oct 09, 2026, page BSON_READER_NEW_FROM_HANDLE(3) — go build something slay today 💖✨🦋

📦 where this page comes from