Section 3: library functions
NAME bson_iter_init() – The bson_iter_init() function shall initialize iter to iterate upon the BSON document bson. Upon initialization, iter is placed before the first element. Callers must call bson_iter_next(), bson_iter_find(), or bson_iter_find_case() to advance to an element. SYNOPSIS bool bson_iter_init (bson_iter_t *iter, const bson_t *bson); PARAMETERS iter A bson_iter_t \&. bson A bson_t \&. DESCRIPTION…
NAME bson_iter_find_descendant() – The bson_iter_find_descendant() function shall follow standard MongoDB dot notation to recurse into subdocuments. descendant will be initialized and advanced to the descendant. If false is returned, both iter and descendant should be considered invalid. SYNOPSIS bool bson_iter_find_descendant(bson_iter_t *iter, const char *dotkey, bson_iter_t *descendant); PARAMETERS iter A bson_iter_t \&. dotkey A dot-notation key…
NAME bson_iter_find_case() – Advances iter until it is observing an element matching the name of key or exhausting all elements. SYNOPSIS bool bson_iter_find_case(bson_iter_t *iter, const char *key); PARAMETERS iter A bson_iter_t \&. key An ASCII string containing the field to locate. DESCRIPTION Advances iter until it is observing an element matching the name of key…
NAME bson_iter_find() – The bson_iter_find()function shall advance iterto the element named keyor exhaust all elements of iter. If iteris exhausted, false is returned and itershould be considered invalid. SYNOPSIS bool bson_iter_find(bson_iter_t *iter, const char *key); PARAMETERS iter A bson_iter_t \&. key A string containing the requested key. DESCRIPTION The bson_iter_find(3) function shall advance iter to…
NAME bson_iter_dup_utf8() – This function is similar to bson_iter_utf8() except that it calls bson_strndup() on the result. SYNOPSIS char * bson_iter_dup_utf8(const bson_iter_t *iter, uint32_t *length); PARAMETERS iter A bson_iter_t \&. length An optional location for the length of the UTF-8 encoded string. DESCRIPTION This function is similar to bson_iter_utf8(3) except that it calls bson_strndup(3) on…
NAME bson_iter_double() – Fetches the contents of a BSON_TYPE_DOUBLE field. SYNOPSIS #define BSON_ITER_HOLDS_DOUBLE(iter) \ (bson_iter_type((iter)) == BSON_TYPE_DOUBLE) double bson_iter_double(const bson_iter_t *iter); PARAMETERS iter A bson_iter_t \&. DESCRIPTION Fetches the contents of a BSON_TYPE_DOUBLE field. RETURNS A double. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER. Index
NAME bson_iter_document() – The bson_iter_document() function shall retrieve the raw buffer of a sub-document from iter. iter MUST be on an element that is of type BSON_TYPE_DOCUMENT. This can be verified with bson_iter_type() or the BSON_ITER_HOLDS_DOCUMENT() macro. SYNOPSIS #define BSON_ITER_HOLDS_DOCUMENT(iter) \ (bson_iter_type((iter)) == BSON_TYPE_DOCUMENT) void bson_iter_document(const bson_iter_t *iter, uint32_t *document_len, const uint8_t **document); PARAMETERS iter…
NAME bson_iter_dbpointer() – Fetches the contents of a BSON_TYPE_DBPOINTER element. SYNOPSIS void bson_iter_dbpointer(const bson_iter_t *iter, uint32_t *collection_len, const char **collection, const bson_oid_t **oid); PARAMETERS iter A bson_iter_t \&. collection_len A location for the length of the collection name. collection A location for the collection name.. oid A location for a bson_oid_t \&. DESCRIPTION Fetches the…
NAME bson_iter_date_time() – The bson_iter_date_time() function shall return the number of miliseconds since the UNIX epoch, as contained in the BSON_TYPE_DATE_TIME element. SYNOPSIS #define BSON_ITER_HOLDS_DATE_TIME(iter) \ (bson_iter_type((iter)) == BSON_TYPE_DATE_TIME) int64_t bson_iter_date_time(const bson_iter_t *iter); PARAMETERS iter A bson_iter_t \&. DESCRIPTION The bson_iter_date_time() function shall return the number of miliseconds since the UNIX epoch, as contained in…
NAME bson_iter_codewscope() – The bson_iter_codewscope() function acts similar to bson_iter_code() except for BSON_TYPE_CODEWSCOPE elements. It also will provide a pointer to the buffer for scope, which can be loaded into a bson_t using bson_init_static(). SYNOPSIS #define BSON_ITER_HOLDS_CODEWSCOPE(iter) \ (bson_iter_type((iter)) == BSON_TYPE_CODEWSCOPE) const char * bson_iter_codewscope(const bson_iter_t *iter, uint32_t *length, uint32_t *scope_len, const uint8_t **scope); PARAMETERS…
NAME bson_iter_code() – This function returns the contents of a BSON_TYPE_CODE field. The length of the string is stored in length if non-NULL. SYNOPSIS #define BSON_ITER_HOLDS_CODE(iter) \ (bson_iter_type((iter)) == BSON_TYPE_CODE) const char * bson_iter_code(const bson_iter_t *iter, uint32_t *length); PARAMETERS iter A bson_iter_t \&. length A location for the length of the UTF-8 encoded string or…
NAME bson_iter_bool() – The bson_iter_bool()function shall return the boolean value of a BSON_TYPE_BOOL element. It is a programming error to call this function on an element other than BSON_TYPE_BOOL. You can check this with bson_iter_type() or BSON_ITER_HOLDS_BOOL(). SYNOPSIS #define BSON_ITER_HOLDS_BOOL(iter) \ (bson_iter_type((iter)) == BSON_TYPE_BOOL) bool bson_iter_bool(const bson_iter_t *iter); PARAMETERS iter A bson_iter_t \&. DESCRIPTION The…
NAME bson_iter_binary() – This function shall return the binary data of a BSON_TYPE_BINARY element. It is a programming error to call this function on a field that is not of type BSON_TYPE_BINARY. You can check this with the BSON_ITER_HOLDS_BINARY() macro or bson_iter_type(). SYNOPSIS #define BSON_ITER_HOLDS_BINARY(iter) \ (bson_iter_type((iter)) == BSON_TYPE_BINARY) void bson_iter_binary(const bson_iter_t *iter, bson_subtype_t *subtype,…
NAME bson_iter_as_int64() – The bson_iter_as_int64() function shall return the contents of the current element as if it were a BSON_TYPE_INT64 element. The currently supported casts include: SYNOPSIS int64_t bson_iter_as_int64(const bson_iter_t *iter); PARAMETERS iter A bson_iter_t \&. DESCRIPTION The bson_iter_as_int64(3) function shall return the contents of the current element as if it were a BSON_TYPE_INT64 element….
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…