bson_get_data (3) - Linux Manuals
bson_get_data: The bson_get_data() function shall return the raw buffer of a bson document. This can be used in conjunction with the len property of a bson_t if you want to copy the raw buffer around.
Command to display bson_get_data manual in Linux: $ man 3 bson_get_data
NAME
bson_get_data() - The bson_get_data() function shall return the raw buffer of a bson document. This can be used in conjunction with the len property of a bson_t if you want to copy the raw buffer around.
SYNOPSIS
const uint8_t *
bson_get_data (const bson_t *bson);
PARAMETERS
- bson
-
A
bson_t
\&.
DESCRIPTION
The
bson_get_data(3)
function shall return the raw buffer of a bson document. This can be used in conjunction with the
len
property of a
bson_t
if you want to copy the raw buffer around.
RETURNS
A buffer which should not be modified or freed.
COLOPHON
This page is part of libbson.
Please report any bugs at
https://jira.mongodb.org/browse/CDRIVER.
Pages related to bson_get_data
- bson_get_major_version (3) - Get the first number in libbson's MAJOR.MINOR.MICRO release version.
- bson_get_micro_version (3) - Get the third number in libbson's MAJOR.MINOR.MICRO release version.
- bson_get_minor_version (3) - Get the middle number in libbson's MAJOR.MINOR.MICRO release version.
- bson_get_version (3) - A string representation of Libbson's version, formatted something like "1.2.3" or "1.2.3-dev".
- bson_append_array (3) - The bson_append_array() function shall append child to bson using the specified key. The type of the field will be an array, but it is the responsibility of the caller to ensure that the keys of child are properly formatted with string keys such as "0", "1", "2" and so forth.
- bson_append_array_begin (3) - The bson_append_array_begin() function shall begin appending an array field to bson. This allows for incrementally building a sub-array. Doing so will generally yield better performance as you will serialize to a single buffer. When done building the sub-array, the caller MUST call bson_append_array_end().
- bson_append_array_end (3) - The bson_append_array_end() function shall complete the appending of an array field started with bson_append_array_begin(). child is invalid after calling this function.
- bson_append_binary (3) - The bson_append_binary() function shall append a new element to bson containing the binary data provided.
- bson_append_bool (3) - The bson_append_bool() function shall append a new element to bson containing the boolean provided.