BSON_VECTOR_PA...IEW_READ_PACKED(3)

🎀 NAME 🎀

okay bestie, welcome to the libbson manual page for bson_vector_packed_bit_const_view_read_packed — the function that copies a contiguous block of packed bytes out of a bson_vector_packed_bit_const_view_t. ✨

💖 SYNOPSIS 💖

bool
bson_vector_packed_bit_const_view_read_packed (bson_vector_packed_bit_const_view_t view,
                                               uint8_t *packed_values_out,
                                               size_t byte_count,
                                               size_t vector_offset_bytes);

🦋 PARAMETERS 🦋

• view — a valid bson_vector_packed_bit_const_view_t. like, it gotta be valid, bestie.
• packed_values_out — the location where the packed bytes will be read to.
• byte_count — number of bytes to read.
• vector_offset_bytes — the byte index of the first packed byte to read.

🌸 DESCRIPTION 🌸

Packed bytes get copied in bulk from the view straight to the output pointer you handed over. it's giving efficient, no cap. 💅

If the Vector's element count isn't a multiple of 8, its final byte will include bits that do not belong to any element. Vector validation checks that these bits are zero. 👀

🔥 RETURNS 🔥

If the byte_count and vector_offset_bytes parameters overflow the bounds of the Vector, it returns false without taking any other action. If the parameters are in range, this is guaranteed to succeed — periodt. On success, it returns true and reads byte_count bytes into *packed_values_out. 💖

🔎 SEE ALSO 🔎

• bson_vector_packed_bit_view_read_packed()
• bson_vector_packed_bit_view_write_packed()

👑 AUTHOR 👑

MongoDB, Inc

📜 COPYRIGHT 📜

2009-present, MongoDB, Inc.

---

and that's the whole vibe! this page comes from libbson version 2.5.6, date stamp Oct 09, 20 — mwah, go read some packed bytes bestie 💋🫶