NAME bson_iter_as_bool() – Fetches the current field as if it were a boolean. SYNOPSIS bool bson_iter_as_bool(const bson_iter_t *iter); PARAMETERS iter A bson_iter_t \&. DESCRIPTION Fetches the current field as if it were a boolean. bson_iter_as_bool(3) currently knows how to determine a boolean value from the following types: \[bu] BSON_TYPE_BOOL \[bu] BSON_TYPE_DOUBLE \[bu] BSON_TYPE_INT32 \[bu] BSON_TYPE_INT64…
NAME bson_iter_array() – The bson_iter_array() function shall retrieve the raw buffer of a sub-array from iter. iter MUST be on an element that is of type BSON_TYPE_ARRAY. This can be verified with bson_iter_type() or the BSON_ITER_HOLDS_ARRAY() macro. SYNOPSIS void bson_iter_array(const bson_iter_t *iter, uint32_t *array_len, const uint8_t **array); PARAMETERS iter A bson_iter_t \&. array_len A location…
NAME bson_init_static() – The bson_init_static() function shall 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. SYNOPSIS bool bson_init_static (bson_t *b, const uint8_t *data, size_t length); PARAMETERS b A bson_t \&. data A…
NAME bson_init_from_json() – The bson_init_from_json() function will initialize a new bson_t by parsing the JSON found in data. Only a single JSON object may exist in data or an error will be set and false returned. SYNOPSIS bool bson_init_from_json(bson_t *bson, const char *data, ssize_t len, bson_error_t *error); PARAMETERS bson A bson_t \&. data A UTF-8…
NAME bson_init() – The bson_init() function shall initialize a bson_t that is placed on the stack. This is equivalent to initializing a bson_t to BSON_INITIALIZER. SYNOPSIS void bson_init(bson_t *b); PARAMETERS b A bson_t \&. DESCRIPTION The bson_init(3) function shall initialize a bson_t that is placed on the stack. This is equivalent to initializing a bson_t…
NAME bson_has_field() – Checks to see if key contains an element named key. This also accepts "dotkey" notation such as "a.b.c.d". SYNOPSIS bool bson_has_field(const bson_t *bson, const char *key); PARAMETERS bson A bson_t \&. key A string containing the name of the field to check for. DESCRIPTION Checks to see if key contains an element…
NAME bson_get_version() – A string representation of Libbson’s version, formatted something like "1.2.3" or "1.2.3-dev". SYNOPSIS const char * bson_get_version(void); DESCRIPTION A string representation of Libbson’s version, formatted something like "1.2.3" or "1.2.3-dev". RETURNS A string you must not modify or free. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER….
NAME bson_get_minor_version() – Get the middle number in libbson’s MAJOR.MINOR.MICRO release version. SYNOPSIS int bson_get_minor_version(void); DESCRIPTION Get the middle number in libbson’s MAJOR.MINOR.MICRO release version. RETURNS The value of BSON_MINOR_VERSION when Libbson was compiled. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER. Index
NAME bson_get_micro_version() – Get the third number in libbson’s MAJOR.MINOR.MICRO release version. SYNOPSIS int bson_get_micro_version(void); DESCRIPTION Get the third number in libbson’s MAJOR.MINOR.MICRO release version. RETURNS The value of BSON_MICRO_VERSION when Libbson was compiled. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER. Index
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…
NAME bson_free() – This function shall free the memory supplied by mem. This should be used by functions that require you free the result with bson_free(). SYNOPSIS void bson_free(void *mem); PARAMETERS mem A memory region. DESCRIPTION This function shall free the memory supplied by mem \&. This should be used by functions that require you…
NAME bson_error_t – BSON Error Encapsulation SYNOPSIS #include <bson.h> typedef struct { uint32_t domain; uint32_t code; char message[504]; } bson_error_t; DESCRIPTION The bson_error_t structure is used to encapsulate information about an error. Think of it as the information stored in an exception without stack trace information. It includes information about the module and error code…
NAME bson_equal() – The bson_equal() function shall return true if both documents are equal. SYNOPSIS bool bson_equal(const bson_t *bson, const bson_t *other); PARAMETERS bson A bson_t \&. other A bson_t \&. DESCRIPTION The bson_equal(3) function shall return true if both documents are equal. RETURNS true if both documents are equal. COLOPHON This page is part…
NAME bson_destroy_with_steal() – The bson_destroy_with_steal() function shall destroy a bson_t structure but return the underlying buffer instead of freeing it. If steal is false, this is equivalent to calling bson_destroy(). It is a programming error to call this function on a bson_t that is not a top-level bson_t, shuch as those initialized with bson_append_document_begin(), bson_append_array_begin(),…
NAME bson_destroy() – The bson_destroy() function shall free an allocated bson_t structure. SYNOPSIS void bson_destroy(bson_t *bson); PARAMETERS bson A bson_t \&. DESCRIPTION The bson_destroy(3) function shall free an allocated bson_t structure. This function should always be called when you are done with a bson_t unless otherwise specified. COLOPHON This page is part of libbson. Please…
NAME bson_count_keys() – The bson_count_keys() function shall count the number of elements within bson. SYNOPSIS uint32_t bson_count_keys(const bson_t *bson); PARAMETERS bson A bson_t \&. DESCRIPTION The bson_count_keys(3) function shall count the number of elements within bson \&. RETURNS A positive integer or zero. COLOPHON This page is part of libbson. Please report any bugs at…
NAME bson_copy_to_excluding() – The bson_copy_to_excluding() function shall copy all fields from src to dst except those speified by the variadic, NULL terminated list of keys starting from first_exclude. SYNOPSIS void bson_copy_to_excluding(const bson_t *src, bson_t *dst, const char *first_exclude, …) BSON_GNUC_NULL_TERMINATED; PARAMETERS src A bson_t \&. dst A bson_t \&. first_exclude The first field name to…
NAME bson_copy_to() – The bson_copy_to() function shall initialize dst with a copy of the contents of src. SYNOPSIS void bson_copy_to(const bson_t *src, bson_t *dst); PARAMETERS src A bson_t \&. dst A bson_t \&. DESCRIPTION The bson_copy_to(3) function shall initialize dst with a copy of the contents of src \&. dst MUST be an uninitialized bson_t…
NAME bson_copy() – The bson_copy() function shall copy the contents of a bson document into a new bson_t. SYNOPSIS bson_t * bson_copy(const bson_t *bson); PARAMETERS bson A bson_t \&. DESCRIPTION The bson_copy(3) function shall copy the contents of a bson document into a new bson_t \&. The resulting bson_t should be freed with bson_destroy(3) \&….
NAME bson_context_t – BSON OID Generation Context SYNOPSIS #include <bson.h> typedef enum { BSON_CONTEXT_NONE = 0, BSON_CONTEXT_THREAD_SAFE = (1 << 0), BSON_CONTEXT_DISABLE_HOST_CACHE = (1 << 1), BSON_CONTEXT_DISABLE_PID_CACHE = (1 << 2), #if defined(__linux__) BSON_CONTEXT_USE_TASK_ID = (1 << 3), #endif } bson_context_flags_t; typedef struct _bson_context_t bson_context_t; bson_context_t *bson_context_get_default(void) BSON_GNUC_CONST; bson_context_t *bson_context_new(bson_context_flags_t flags); void bson_context_destroy(bson_context_t *context); DESCRIPTION…