BSON_VECTOR_PA...ST_VIEW_PADDING(3)

📦
version 2.5.6 · 3 versions
, in epel 10

💅 BSON_VECTOR_PA...ST_VIEW_PADDING(3) 💅

okay so bestie, this page is from libbson, and it's about the function that returns the number of unused bits in a Vector referenced by a bson_vector_packed_bit_const_view_t. Lowkey niche, highkey useful, and we're gonna get through it together. 🫶

✨ SYNOPSIS ✨

size_t
bson_vector_packed_bit_const_view_padding (bson_vector_packed_bit_const_view_t view);

🎀 PARAMETERS 🎀

  • view — a valid bson_vector_packed_bit_const_view_t. That's the whole vibe check here, no cap.

🦋 DESCRIPTION 🦋

So what's happening inside? The function takes a copy of the Vector header that lives inside view, and extracts the 3-bit padding field from it. It's giving "look inside the header, grab the padding, slay." ✨

🌸 RETURNS 🌸

It hands you the number of unused bits in the final packed byte. Guaranteed to be between 0 and 7 inclusive, fr fr. And because Vector validation is that girl, empty Vectors are guaranteed to have a padding of 0. 👑

👀 SEE ALSO 👀

  • bson_vector_packed_bit_view_padding()

💜 AUTHOR 💜

MongoDB, Inc

2009-present, MongoDB, Inc.

Signed with love by libbson — footer source/version 2.5.6, date starting Oct 09, 20 (the rest got clipped by the header, bestie, not me making stuff up) 💖✨🦋

📦 where this page comes from