BSON_VECTOR_PA..._VIEW_FROM_ITER(3)

📦
version 2.5.6 · 3 versions
, in epel 10

💖 BSON_VECTOR_PA..._VIEW_FROM_ITER(3) 💖

okay bestie, welcome to the libbson manual page for bson_vector_packed_bit_view_from_iter() 💅 this one is short but she's important, so let's get into it.

🌸 NAME 🌸

Initialize a bson_vector_packed_bit_view_t from a bson_iter_t pointing to a valid Vector of packed_bit element type. That's the whole vibe ✨

✨ SYNOPSIS ✨

          bool
          bson_vector_packed_bit_view_from_iter (bson_vector_packed_bit_view_t *view_out,
                                                 bson_iter_t *iter);

🎀 PARAMETERS 🎀

  • view_out — A bson_vector_packed_bit_view_t is written here on success. She gets the goods 🫶
  • iter — A valid bson_iter_t. No funny business, just a valid iterator.

🦋 DESCRIPTION 🦋

The provided iterator, which must point to some kind of BSON item, will be checked for a valid Vector of packed_bit element type. On success, a bson_vector_packed_bit_view_t is set to point to the same underlying bson_t buffer as the provided bson_iter_t. Same buffer energy, iykyk 🦋

⚠️ real talk: the view will only be valid until the containing document is destroyed or otherwise modified. Do not keep it around after that, bestie — that's not the vibe check you want 💀

🌈 RETURNS 🌈

Returns true if the view was successfully initialized. periodt 💅

👑 AUTHOR 👑

MongoDB, Inc — iconic, fr fr 👑

2009-present, MongoDB, Inc.

xoxo, your libbson bestie 💜 — this page is from libbson version 2.5.6, dated Oct 09, 20 (yes, the footer is giving truncated 😭, but that's what it says).

📦 where this page comes from