BSON_APPEND_ITER(3)

📦
version 2.5.6 · 16 versions
, in epel 10

🫶 BSON_APPEND_ITER(3) — a libbson moment

okay so bestie, welcome to the libbson section 3 glow-up, where we're talking about bson_append_iter — literally the "copy that element right there, no thoughts just vibes" function. ✨

🌸 SYNOPSIS 🌸

bool
bson_append_iter (bson_t *bson,
                  const char *key,
                  int key_length,
                  const bson_iter_t *iter);

that's the whole signature, no cap. four args, one bool back. iconic. 💅

🎀 PARAMETERS 🎀

  • bson — a bson_t. your destination document, the main character here. 👑
  • key — optional field name. if it's NULL, it just goes ahead and uses bson_iter_key(iter) instead — like, it already knows the name, why repeat yourself fr fr.
  • key_length — the length of key, or -1 if you want it to just run strlen() and figure it out itself. 🙈
  • iter — a bson_iter_t that is located on the position of the element to append. like it has to actually be sitting on the thing, don't just hand over any old iterator. 👀

🦋 DESCRIPTION 🦋

Appends the value at the current position of iter to the document. that's it, that's the whole job. lowkey elegant. ✨

⭐ RETURNS ⭐

Returns true if successful — slay. 💖

Returns false if the operation would overflow the maximum document size, or if another invalid state is detected. so like, listen for the false, it's not just being dramatic. 😭

bestie pls always check the return value, a false means something genuinely went wrong, not just a vibe check failure. 💀

🌈 AUTHOR 🌈

MongoDB, Inc — the icons who brought you this whole thing. 🫶

2009-present, MongoDB, Inc. periodt. 👑

and that's the tea 🍓 — this page is from libbson version 2.5.6, dated Oct 09, 2026, so go forth and append responsibly, bestie 💜

📦 where this page comes from