BSON_ITER_BINARY_SUBTYPE(3)

📦
version 2.5.6 · 3 versions
, in epel 10

💅 BSON_ITER_BINARY_SUBTYPE(3) 💅

okay so bestie, welcome to libbson's very own bson_iter_binary_subtype page — yes that's a mouthful, no we're not changing it, the C people decided ✨

🌸 SYNOPSIS 🌸

bson_subtype_t
bson_iter_binary (const bson_iter_t *iter);

wait. not me almost typos the function name 😭 it's actually:

bson_subtype_t
bson_iter_binary_subtype (const bson_iter_t *iter);

like, literally copy it exactly, the compiler is not forgiving and neither is the linker 💀

🎀 PARAMETERS 🎀

  • iter — a bson_iter_t. that's it. that's the whole parameter list. one (1) iterator, she's the main character 🫶

🦋 DESCRIPTION 🦋

so the way this works: this function shall return the subtype of a BSON_TYPE_BINARY element. that's her whole job, she's an icon, she does one thing and she slays at it 👑

now for the vibe check ⚠️ — it is a programming error to call this function on a field that is not of type BSON_TYPE_BINARY. like, not "oopsie" error, not "warn you gently" error, we're talking you did this to yourself error. check first, babes, always check first 🙈

you can check with the BSON_ITER_HOLDS_BINARY() macro, or lowkey with bson_iter_type() if that's more your vibe. both work, pick your fighter 💖

and fyi, this function is equivalent to the subtype output parameter of bson_iter_binary() — same info, just served directly to you instead of through the out-param. convenient? yes. iconic? also yes 🍓

🌟 AUTHOR 🌟

MongoDB, Inc — yeah, the database people, doing the most as usual 💜

2009-present, MongoDB, Inc. — long run, no cap, they've been at this since 2009 and they're still going 🔥

real talk though bestie: type-check with BSON_ITER_HOLDS_BINARY() before you call her. it's giving self-care, it's giving not-crashing-at-3am, it's giving responsible C programmer energy 🧚

and that's the page!! mwah 💋 this cutie came to you from libbson 2.5.6, dated Oct 09, 2026 — screenshot it, frame it, put it on your fridge, BSON_ITER_BINARY_SUBTYPE(3) forever ⭐🎀 periodt 🎀⭐

📦 where this page comes from