BSON_VECTOR_PA...IEW_UNPACK_BOOL(3)

💅 BSON_VECTOR_PA...IEW_UNPACK_BOOL(3) 💅

okay so bestie, welcome to libbson, section 3 of the manual — this one's all about bson_vector_packed_bit_const_view_unpack_bool, and yes the header name is literally truncated like that in the page title, we don't make the rules, we just vibe with them ✨

This function unpacks a contiguous block of elements from a bson_vector_packed_bit_const_view_t into a C array of bool. slay.

---

🌸 SYNOPSIS 🌸

bool
bson_vector_packed_bit_const_view_unpack_bool (bson_vector_packed_bit_const_view_t view,
                                               bool *unpacked_values_out,
                                               size_t element_count,
                                               size_t vector_offset_elements);

---

🎀 PARAMETERS 🎀

• view — a valid bson_vector_packed_bit_const_view_t. valid is the vibe check here, no cap 🫶
• unpacked_values_out — the location where the bool elements will get unpacked to. it's giving "destination energy" ✨
• element_count — how many elements to unpack. literally the count 🤌
• vector_offset_elements — the vector index of the first element to unpack. where we start, queen 👑

---

🦋 DESCRIPTION 🦋

Elements are unpacked from individual bits into a C array of bool. like, one bit each, glow-up into a full bool, iconic behavior honestly 🧚

---

⭐ RETURNS ⭐

If the element_count and vector_offset_elements parameters overflow the bounds of the Vector, it returns false without taking any other action — so nothing else happens, it just says no 🙈

If the parameters are in range, this is guaranteed to succeed. periodt. On success it returns true and unpacks element_count elements into *unpacked_values_out 🎉

heads up bestie: if the parameters are out of range, false is the whole answer — no partial unpacking, no side quests 💀

SEE ALSO:

• bson_vector_packed_bit_view_unpack_bool()

---

👑 AUTHOR 👑

MongoDB, Inc

---

💜 COPYRIGHT 💜

2009-present, MongoDB, Inc.

---

that's the whole page, mwah 💖 — brought to you by libbson 2.5.6, dated Oct 09, 20… (the footer got a little cut off mid-year, but she's still gorgeous), and that's on BSON_VECTOR_PA...IEW_UNPACK_BOOL(3) fr fr 🌈✨🎀