BSON_ITER_DOCUMENT(3)

📦
version 2.5.6 · 16 versions
, in epel 10

💅 BSON_ITER_DOCUMENT(3) — libbson says hiii, bestie ✨

🌸 SYNOPSIS 🌸

          #define BSON_ITER_HOLDS_DOCUMENT(iter) \
             (bson_iter_type ((iter)) == BSON_TYPE_DOCUMENT)

          void
          bson_iter_document (const bson_iter_t *iter,
                              uint32_t *document_len,
                              const uint8_t **document);

🎀 PARAMETERS 🎀

  • iter — a bson_iter_t. That’s your iterator bestie. 🫶
  • document_len — a location for the length of the document in bytes. Yes, bytes, not vibes. 💅
  • document — a location for the document buffer. 🎀

🦋 DESCRIPTION 🦋

okay so the bson_iter_document() function shall retrieve the raw buffer of a sub-document from iter — that’s the whole assignment, bestie. 💖

🚨 MUST alert: iter MUST be on an element that is of type BSON_TYPE_DOCUMENT. Uppercase MUST, bestie — this is not optional, no cap. 😭

You can verify that with bson_iter_type() or the BSON_ITER_HOLDS_DOCUMENT() macro. Slay. ✨

👑 AUTHOR 👑

MongoDB, Inc

2009-present, MongoDB, Inc.

mwah 💋 — this page is from libbson 2.5.6, dated Oct 09, 2026. byeeeee 🫶

📦 where this page comes from