Scroll to navigation

BSON_INIT_STATIC(3) libbson BSON_INIT_STATIC(3)

SYNOPSIS

bool
bson_init_static (bson_t *b, const uint8_t *data, size_t length);


PARAMETERS

  • b: A bson_t <>.
  • data: A buffer to initialize with.
  • length: The length of data in bytes.

DESCRIPTION

The bson_init_static() <> function shall initialize a read-only bson_t <> on the stack using the data provided. No copies of the data will be made and therefore must remain valid for the lifetime of the bson_t <>.

The resulting bson_t has internal references and therefore must not be copied to avoid dangling pointers in the copy.

RETURNS

Returns true if bson_t <> was successfully initialized, otherwise false. The function can fail if data or length are invalid.

Author

MongoDB, Inc

Copyright

2009-present, MongoDB, Inc.

December 11, 2025 2.2.1