BSON_ITER_BINARY_EQUAL(3)

💅 BSON_ITER_BINARY_EQUAL 💅

okay so bestie, welcome to BSON_ITER_BINARY_EQUAL(3) from the libbson manual — yes that libbson, the one you keep forgetting to read the docs for 🫶. this one's short and sweet and honestly kinda iconic, so let's get into it.

---

✨ SYNOPSIS ✨

bool
bson_iter_binary_equal (const bson_iter_t *iter_a, const bson_iter_t *iter_b);

that's the whole signature, no cap. two iterators go in, one bool comes out 🌸

---

🎀 PARAMETERS 🎀

• iter_a — A bson_iter_t. just, like, one of them. the first one 💖
• iter_b — A bson_iter_t. and the other one. the second one. the comparison partner, the main character to iter_a's main character 😭

---

🦋 DESCRIPTION 🦋

Compare two BSON_TYPE_BINARY fields for exact equality. like, exact exact. no vibes-based approximations here, we're doing a real comparison 💅

and here's the tea: this is the preferred way to compare BSON Binary Vector subtype values for equality. so if you were out here hand-rolling your own binary comparison for vector subtypes... bestie. no. put that down. use this one 🫶

---

👑 RETURNS 👑

true if both iterators point to BSON_TYPE_BINARY fields with identical subtype and contents ✨

false if there is any difference in subtype, length, or content, or if the fields are not binary type. yeah — not-binary counts as a fail too, so don't come at this function with a string and expect a good time 🙈

lowkey important: false is doing a lot of heavy lifting in that sentence. different subtype? false. different length? false. different content? false. literally not binary at all? also false. it's giving "no notes, just no" 💀

---

🌈 AUTHOR 🌈

MongoDB, Inc — shoutout to the whole team, they ate 👑

---

⭐ COPYRIGHT ⭐

2009-present, MongoDB, Inc. — protecting the whole thing since 2009, fr fr 🎀

---

and that's the page!! version 2.5.6, dated Oct 09, 2026, BSON_ITER_BINARY_EQUAL(3) — go forth and compare your binaries exactly, bestie 🦋💜🍓