BSON_ITER_BOOL(3)

💖 BSON_ITER_BOOL(3) — the libbson glow-up 💖

okay so bestie, welcome to the <pink>BSON_ITER_BOOL</pink> page of the libbson manual (libbson, section 3, if you're keeping track 🎀). this is the one that gets you a bool out of your iterator, and honestly? it's giving tiny-but-mighty. let's get into it ✨

---

🌸 SYNOPSIS 🌸

here's the whole vibe, literally verbatim:

#define BSON_ITER_HOLDS_BOOL(iter) (bson_iter_type ((iter)) == BSON_TYPE_BOOL)

bool
bson_iter_bool (const bson_iter_t *iter);

so you've got a macro for the vibe check (BSON_ITER_HOLDS_BOOL) and then the actual function, bson_iter_bool, which takes a const bson_iter_t * and hands you back a bool. slay. 🫶

---

🦋 PARAMETERS 🦋

• iter — a bson_iter_t. that's it. that's the whole list. simple, iconic, no notes 💅

---

✨ DESCRIPTION ✨

so the bson_iter_bool() function shall return the boolean value of a BSON_TYPE_BOOL element. periodt. 🎀

⚠️ but listen — it is a programming error to call this function on an element that is not a BSON_TYPE_BOOL. like, not "oopsie" error, we mean you wrote a bug error. do not do it. 🙈

you can check that it's actually safe to call with bson_iter_type() or, even cuter, BSON_ITER_HOLDS_BOOL(). vibe check first, bool second. iykyk 💀

---

🔥 RETURNS 🔥

either true or false. that's the whole returns section. binary queen behavior, honestly 👑✨

---

💜 AUTHOR 💜

MongoDB, Inc 🫶

---

🌈 COPYRIGHT 🌈

2009-present, MongoDB, Inc. — protecting the brand since forever, no cap 💖

---

and that's the whole page, bestie! 🌸 this was libbson 2.5.6, dated Oct 09, 2026 — catch you on the next man page, mwah 🧚💅🍓