BSON_VALIDATE(3)

📦
version 2.5.6 · 16 versions
, in epel 10

💅 BSON_VALIDATE(3) — the libbson one, bestie

okay so like, this is the bson_validate page from libbson, and it's genuinely one of the most useful little functions ever. no cap. let's get into it 🫶

✨ SYNOPSIS ✨

bool
bson_validate (const bson_t *bson, bson_validate_flags_t flags, size_t *offset);

like, that's the whole vibe. three args, one bool back. iconic.

🎀 PARAMETERS 🎀

  • bson — a bson_t. the document you're side-eyeing. 👀
  • flags — a bitwise-or of all the bson_validate_flags_t you want. yes, all of them, or just some, you do you.
  • offset — optional spot where the error offset gets written. optional optional. you can literally pass nothing here and it's fine.

💖 DESCRIPTION 💖

so what it does is validate a BSON document — it literally walks through the whole thing, inspecting the keys and the values, checking that the content is valid. like a little vibe check for your bytes. 🌸

and you can change up how the validation happens using the flags parameter — go look at bson_validate_flags_t for the deets, iykyk.

🌈 RETURNS 🌈

if bson passes the validations you asked for, it returns true. slay. 💅

otherwise it returns false, and — if offset is non-NULL — that pointer gets written with the byte offset in the document where the error was detected. so you know exactly where it went wrong. very main character of it.

🚨 heads up bestie: if you want more info about the specific validation failure, use bson_validate_with_error_and_offset() instead. this one's just giving you the offset, not the whole story. 😭

🦋 SEE ALSO

  • bson_validate_with_error()
  • bson_validate_with_error_and_offset()

also! bson_visitor_t can be used for custom validation — see Example Custom Validation. for when you wanna do it your own way, periodt. 🔥

👑 AUTHOR 👑

MongoDB, Inc

2009-present, MongoDB, Inc.

and that's the page!! ✨ version 2.5.6, dated Oct 09, 2026 — mwah, go validate some BSON, bestie 💜🦋

📦 where this page comes from