BSON_VECTOR_FL...VIEW_FROM_ITER(3)

πŸ“¦
version 2.5.6 Β· 3 versions
, in epel 10

okay so this is the libbson page for BSON_VECTOR_FL...VIEW_FROM_ITER(3) β€” yes the title is a whole keyboard smash, but she's iconic and we're gonna get through it together, bestie πŸ«ΆπŸ’…

🌸 NAME 🌸

Initialize a bson_vector_float32_const_view_t from a bson_iter_t pointing to a valid Vector of float32 element type.

✨ SYNOPSIS ✨

bool
bson_vector_float32_const_view_from_iter (bson_vector_float32_const_view_t *view_out,
                                          const bson_iter_t *iter);

πŸŽ€ PARAMETERS πŸŽ€

  • view_out β€” a bson_vector_float32_const_view_t is written here on success. That's where the view lands, no cap.
  • iter β€” a valid bson_iter_t. She has to be valid, bestie, that's the whole vibe.

πŸ’– DESCRIPTION πŸ’–

The provided iterator β€” which must point to some kind of BSON item β€” gets checked for a valid Vector of float32 element type. On success, a bson_vector_float32_const_view_t is set to point to the same underlying bson_t buffer as the provided bson_iter_t.

Heads up: the view will only be valid until the containing document is destroyed or modified. After that it is not valid anymore, periodt. Do not keep it around like a situationship, mkay? 😭

πŸ¦‹ RETURNS πŸ¦‹

Returns true if the view was successfully initialized. That's it, that's the return.

πŸ‘€ SEE ALSO πŸ‘€

  • bson_vector_float32_view_from_iter()

πŸ’œ AUTHOR πŸ’œ

MongoDB, Inc

2009-present, MongoDB, Inc.


that's the whole page, bestie β€” libbson 2.5.6, dated Oct 09, 2024, and it ate. mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from