BSON_VECTOR_PA...ONST_VIEW_INIT(3)

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

πŸ’… BSON_VECTOR_PA...ONST_VIEW_INIT(3) πŸ’…

okay so this is the libbson manual page, bestie β€” the one where we initialize a bson_vector_packed_bit_const_view_t from a const uint8_t buffer. 🫢


✨ SYNOPSIS ✨

          bool
          bson_vector_packed_bit_const_view_init (bson_vector_packed_bit_const_view_t *view_out,
                                                  const uint8_t *binary_data,
                                                  uint32_t binary_data_len);

πŸŽ€ PARAMETERS πŸŽ€

  • view_out β€” a bson_vector_packed_bit_const_view_t gets written here on success. πŸ’–
  • binary_data β€” a pointer to the BSON Binary data block that's getting validated. πŸ”
  • binary_data_len β€” length of the binary data block, in bytes. πŸ“

πŸ¦‹ DESCRIPTION πŸ¦‹

so here's the vibe: the length, header, and trailing padding of the provided binary data block will be checked for a valid Vector of packed_bit element type. ✨

On success, the pointer and length are packaged as a bson_vector_packed_bit_const_view_t written to *view_out. πŸŽ€

⚠️ important: the view will only be valid as long as binary_data is valid. literally do not let that buffer expire while you're still using the view, bestie. 😭

πŸ”₯ RETURNS πŸ”₯

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

πŸ‘€ SEE ALSO πŸ‘€

  • bson_vector_packed_bit_view_init()

πŸ‘‘ AUTHOR πŸ‘‘

MongoDB, Inc

2009-present, MongoDB, Inc.


xoxo, your libbson bestie β€” version 2.5.6, dated Oct 09, 202 πŸ’‹πŸ’…

πŸ“¦ where this page comes from