Scroll to navigation

BSON_VECTOR_INT8_BINARY_DATA_LENGTH(3) libbson BSON_VECTOR_INT8_BINARY_DATA_LENGTH(3)

Calculate the size of a BSON Binary field that would be needed to store a Vector with the indicated number of int8 elements.

SYNOPSIS

uint32_t
bson_vector_int8_binary_data_length (size_t element_count);


PARAMETERS

element_count: Number of elements, as a size_t.

DESCRIPTION

Checks element_count against the maximum representable size, and calculates the required Binary size.

RETURNS

On success, returns the required Binary size as a uint32_t greater than or equal to BSON_VECTOR_HEADER_LEN. This length includes the 2-byte Vector header, but not the Binary subtype header or any other BSON headers. If the element_count is too large to represent, returns 0.

AUTHOR

MongoDB, Inc

COPYRIGHT

2009-present, MongoDB, Inc.

June 17, 2025 2.0.2