BSON_READER_NEW_FROM_FILE(3)

📦
version 2.5.6 · 16 versions
, in epel 10

✨ bson_reader_new_from_file — a libbson moment ✨

okay so bestie, welcome to the libbson corner of the man pages 💖 this one's about bson_reader_new_from_file, and honestly? it's giving "tiny function, big responsibility" energy. it takes a file and hands you back a whole reader. slay 🎀

🌈 SYNOPSIS 🌈

bson_reader_t *
bson_reader_new_from_file (const char *path, bson_error_t *error);

that's it. that's the whole vibe. two args, one return, no cap 💅

🦋 PARAMETERS 🦋

  • path — a filename, and like… it's in the host filename encoding, bestie. that detail matters, ok? don't come for me, it's literally what the docs say 🫶
  • error — a bson_error_t. that's where the drama gets reported if things go sideways 😭

💖 DESCRIPTION 💖

so what does it do? it creates a brand new bson_reader_t using the file denoted by filename. that's the whole story, no plot twists 🌸 like, it looks at your file, it builds you a reader, iconic behavior honestly 👑

(and yes, the parameter is called path up in the signature but filename down here in the description — that's just how the original rolls, iykyk 🙈 we love a little naming inconsistency, it's part of the charm.)

💀 ERRORS 💀

errors are propagated via the error parameter. so like, nothing gets silently yeeted into the void — if something's wrong, it shows up in error where you can actually see it 🧚

⭐ RETURNS ⭐

  • on success → a newly allocated bson_reader_t 🎉 (newly allocated, so like… that's yours to deal with, bestie — please free it)
  • on failure → NULL, and error gets set 📉
lowkey important: NULL doesn't mean "no data", it means "it didn't work, check your error" — don't be out here dereferencing it, that's not the move 😭💀

👑 AUTHOR 👑

MongoDB, Inc 🫶

2009-present, MongoDB, Inc. — and yes that "present" is doing a lot of work, they've been at this a minute 💜

okay that's the whole page, bestie, you're basically a bson_reader_new_from_file expert now 🎀✨ mwah 💋

version 2.5.6 · dated Oct 09, 2026 · that's the tea, see u in the next man page 🌈💅

📦 where this page comes from