BSON_ITER_REGEX(3)

✨ BSON_ITER_REGEX(3) ✨

okay so bestie, this is a libbson page 💅 and honestly it's a short one, so let's get into it 🎀

---

🌸 SYNOPSIS 🌸

const char *
bson_iter_regex (const bson_iter_t *iter, const char **options);

---

💖 PARAMETERS 💖

• iter — a bson_iter_t. that's your iterator bestie, the little main character doing the walking 👑
• options — a (null). yes literally, that's what it says. this is a const char ** out-param situation 🫶

---

🦋 DESCRIPTION 🦋

so the bson_iter_regex() function shall retrieve the contents of a BSON_TYPE_REGEX element that iter is currently observing. like, it grabs the regex for you, no cap ✨

⚠️ okay important vibe check: it is invalid to call this function when you're not observing an element of type BSON_TYPE_REGEX. fr fr, don't do it 💀

---

⭐ RETURNS ⭐

a string containing the regex 💖 — and listen, this string should not be modified or freed, so hands off, it's not yours 🙈

and options gets set to the options provided for the regex. iconic 🎀

---

👑 AUTHOR 👑

MongoDB, Inc 🌈

---

💜 COPYRIGHT 💜

2009-present, MongoDB, Inc. 🍓

---

and that's the whole page bestie, we ate and left no crumbs 💅✨ this was libbson version 2.5.6, dated Oct 09, 2026 — see you in the next one 🧚‍♀️🫶