BSON_VECTOR_PA..._VIEW_FROM_ITER(3)

📦
version 2.5.6 · 3 versions
, in epel 10

🦋 libbson manual: BSON_VECTOR_PA..._VIEW_FROM_ITER(3) 🦋

okay bestie, this is the libbson page for bson_vector_packed_bit_const_view_from_iter() 💅 It initializes a bson_vector_packed_bit_const_view_t from a bson_iter_t pointing to a valid Vector of packed_bit element type.

✨ SYNOPSIS ✨

          bool
          bson_vector_packed_bit_const_view_from_iter (bson_vector_packed_bit_const_view_t *view_out,
                                                       const bson_iter_t *iter);

🎀 PARAMETERS 🎀

  • view_out — a bson_vector_packed_bit_const_view_t is written here on success. 💖
  • iter — a valid bson_iter_t. ✨

🌸 DESCRIPTION 🌸

The iterator you pass in has to point at some kind of BSON item, and it gets checked for a valid Vector of packed_bit element type. On success, a bson_vector_packed_bit_const_view_t gets set to point at the exact same underlying bson_t buffer as the bson_iter_t you gave it. Iconic.

Heads up, bestie: the view is only valid until the containing document is destroyed or modified. Do not let it outlive that, fr fr. 💀

⭐ RETURNS ⭐

It returns true if the view was successfully initialized. 🫶

👀 SEE ALSO 👀

  • bson_vector_packed_bit_view_from_iter()

👑 AUTHOR 👑

MongoDB, Inc

2009-present, MongoDB, Inc.

mwah 💋 this page is serving libbson 2.5.6, dated Oct 09, 20 (yes, the footer is truncating, no cap 😭), and that's the whole manual page. byeee 🦋

📦 where this page comes from