BSON_VECTOR_PA...IEW_READ_PACKED(3)

💖 BSON_VECTOR_PACKED_BIT_VIEW_READ_PACKED(3) 💖

okay so bestie, this is a libbson page (that's the manual name, slay) and it's all about copying a contiguous block of packed bytes out of a bson_vector_packed_bit_view_t. that's it. that's the whole gig. 🎀

---

✨ SYNOPSIS ✨

bool
bson_vector_packed_bit_view_read_packed (bson_vector_packed_bit_view_t view,
                                         uint8_t *packed_values_out,
                                         size_t byte_count,
                                         size_t vector_offset_bytes);

look at her. gorgeous. four arguments, returns a bool, no notes. 👑

---

🌸 PARAMETERS 🌸

• view — a valid bson_vector_packed_bit_view_t. has to be valid, like, actually valid, not fake-valid. do not play with her.
• packed_values_out — the location where the packed bytes get read to. this is where the bytes land. it's giving destination energy. 📍
• byte_count — how many bytes to read. the count. of the bytes. 🧮
• vector_offset_bytes — the byte index of the very first packed byte to read. like where you start in the vector, but in bytes.

---

🦋 DESCRIPTION 🦋

so the packed bytes get copied in bulk from the view into the output pointer you handed over. bulk copy. no per-bit nonsense. we're moving blocks of bytes, periodt. ✨

now here's the little detail you need in your life: if the Vector's element count isn't a multiple of 8, then its final byte is gonna include bits that do not belong to any element. like, stray bits. squatters. 🙈 and Vector validation checks that these bits are zero. so they're just sitting there being zero and not part of anything. the way that math works out is honestly iconic.

---

⭐ RETURNS ⭐

if byte_count and vector_offset_bytes overflow the bounds of the Vector, this returns false and does literally nothing else. no other action. not a single additional thing. 💀

if the parameters are in range, though? guaranteed to succeed. like, guaranteed guaranteed. on success it returns true and reads byte_count bytes into *packed_values_out. we love a reliable queen. 👑

---

🔥 SEE ALSO 🔥

• bson_vector_packed_bit_const_view_read_packed()
• bson_vector_packed_bit_view_write_packed()

(the read-only sister and the write version, iykyk 🫶)

---

💅 AUTHOR 💅

MongoDB, Inc

🎀 COPYRIGHT 🎀

2009-present, MongoDB, Inc.

---

ngl this one's short and sweet and does exactly what it says on the tin. no cap. 🌈

okay bye bestie, this page was libbson version 2.5.6, dated Oct 09 (the year got tragically truncated in the header, rip 😭), and it's BSON_VECTOR_PACKED_BIT_VIEW_READ_PACKED(3) — catch you in the next man page! 💜🦋🍓