BSON_ITER_KEY(3)

💅 BSON_ITER_KEY 💅

okay bestie so you're out here iterating over BSON and you need the name of the thing your iterator is currently perched on — that's this function, and it's from libbson, the bson_iter_key (3) page. welcome, you're gonna love it here 🫶

---

✨ SYNOPSIS ✨

const char *
bson_iter_key (const bson_iter_t *iter);

one function, two lines, zero drama. she's iconic like that. 🎀

---

🌸 PARAMETERS 🌸

• iter — A bson_iter_t. that's it. that's the whole parameter list, she's low maintenance. 💅

---

🦋 DESCRIPTION 🦋

so basically this is the glow-up moment where you go "okay but WHAT is the key" — bson_iter_key() fetches the key for the current element observed by iter. that's the whole vibe. the element you're sitting on right now? this gives you its key. no cap, that's the entire job. ✨

---

⭐ RETURNS ⭐

it hands you back a string. a const char * string. and hiii quick PSA: this string should not be modified or freed — it's not yours, don't touch it, don't free() it, don't write into it. hands off the merch, bestie. 🙈💀

SEE ALSO: bson_iter_key_len() — use her when you want the length of the key in constant time. like, you don't have to walk the whole string to find the end, she just knows. obsessed. ⚡

---

👑 AUTHOR 👑

MongoDB, Inc

---

🌈 COPYRIGHT 🌈

2009-present, MongoDB, Inc.

---

okay that's the whole page, you're welcome, go slay your BSON parsing 🔥

✨ libbson version 2.5.6 — dated Oct 09, 2026 ✨ — mwah, bye bestie 💖🍓