bson_vector_int8_view_init()#

Initialize a bson_vector_int8_view_t from a mutable uint8_t buffer.

Synopsis#

bool
bson_vector_int8_view_init (bson_vector_int8_view_t *view_out,
                            uint8_t *binary_data,
                            uint32_t binary_data_len);

Parameters#

view_out: A bson_vector_int8_view_t is written here on success.
binary_data: A pointer to the BSON Binary data block to be validated.
binary_data_len: Length of the binary data block, in bytes.

Description#

The length and header of the provided binary data block will be checked for a valid Vector of int8 element type. On success, the pointer and length are packaged as a bson_vector_int8_view_t written to *view_out. The view will only be valid as long as binary_data is valid.

Returns#

Returns true if the view was successfully initialized.