The Linux Manuals (man pages) document is an important part of Linux documents. Linux Manuals are organized as several sections. Each section has a group of commands for a specific area in Linux usage, administration or development.
bson_iter_regex() – The bson_iter_regex() function shall retrieve the contents of a BSON_TYPE_REGEX element currently observed by iter. Synopsisconst char * bson_iter_regex (const bson_iter_t *iter, const char **options);Parametersiter A bson_iter_t \&.options A (null).DescriptionThe bson_iter_regex(3) function shall retrieve the contents of a BSON_TYPE_REGEX element currently observed by iter \&. It is invalid to call this function when…
bson_iter_recurse() – The bson_iter_recurse() function shall initialize child using the embedded document or array currently observed by iter. Synopsisbool bson_iter_recurse (const bson_iter_t *iter, bson_iter_t *child);Parametersiter A bson_iter_t \&.child A bson_iter_t \&.DescriptionThe bson_iter_recurse(3) function shall initialize child using the embedded document or array currently observed by iter \&. If there was a failure to initialize the…
bson_iter_overwrite_int64() – The bson_iter_overwrite_int64() function shall overwite the contents of a BSON_TYPE_INT64 element in place. Synopsisvoid bson_iter_overwrite_int64 (bson_iter_t *iter, int64_t value);Parametersiter A bson_iter_t \&.value A int64_t.DescriptionThe bson_iter_overwrite_int64(3) function shall overwite the contents of a BSON_TYPE_INT64 element in place. This may only be done when the underlying bson document allows mutation. It is a programming error…
bson_iter_overwrite_int32() – The bson_iter_overwrite_int32() function shall overwrite the contents of a BSON_TYPE_INT32 element in place. Synopsisvoid bson_iter_overwrite_int32 (bson_iter_t *iter, int32_t value);Parametersiter A bson_iter_t \&.value A int32_t.DescriptionThe bson_iter_overwrite_int32(3) function shall overwrite the contents of a BSON_TYPE_INT32 element in place. This may only be done when the underlying bson document allows mutation. It is a programming error…
bson_iter_overwrite_double() – The bson_iter_overwrite_double() function shall overwrite the contents of a BSON_TYPE_DOUBLE element in place. Synopsisvoid bson_iter_overwrite_double (bson_iter_t *iter, double value);Parametersiter A bson_iter_t \&.value The new double value.DescriptionThe bson_iter_overwrite_double(3) function shall overwrite the contents of a BSON_TYPE_DOUBLE element in place. This may only be done when the underlying bson document allows mutation. It is a…
bson_iter_overwrite_bool() – The bson_iter_overwrite_bool() function shall overwrite the contents of a BSON_TYPE_BOOL element in place. Synopsisvoid bson_iter_overwrite_bool (bson_iter_t *iter, bool value);Parametersiter A bson_iter_t \&.value A bool containing the new value.DescriptionThe bson_iter_overwrite_bool(3) function shall overwrite the contents of a BSON_TYPE_BOOL element in place. This may only be done when the underlying bson document allows mutation. It…
bson_iter_oid() – Fetches the bson_oid_t for a BSON_TYPE_OID element. You should verify it is an element of type BSON_TYPE_OID before calling this function. Synopsis#define BSON_ITER_HOLDS_OID(iter) \ (bson_iter_type ((iter)) == BSON_TYPE_OID) const bson_oid_t * bson_iter_oid (const bson_iter_t *iter);Parametersiter A bson_iter_t \&.DescriptionFetches the bson_oid_t for a BSON_TYPE_OID element. You should verify it is an element of type…
bson_iter_next() – Advances iter to the next element in the document if one exists. Synopsisbool bson_iter_next (bson_iter_t *iter);Parametersiter A bson_iter_t \&.DescriptionAdvances iter to the next element in the document if one exists. Returnstrue if iter was advanced, otherwise false and iter should be considered invalid. ColophonThis page is part of libbson. Please report any bugs…
bson_iter_key() – Fetches the key for the current element observed by iter. Synopsisconst char * bson_iter_key (const bson_iter_t *iter);Parametersiter A bson_iter_t \&.DescriptionFetches the key for the current element observed by iter \&. ReturnsA string which should not be modified or freed. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
bson_iter_int64() – Fetches the value from a BSON_TYPE_INT64 field. You should verify that this is a BSON_TYPE_INT64 field before calling this function. Synopsis#define BSON_ITER_HOLDS_INT64(iter) \ (bson_iter_type ((iter)) == BSON_TYPE_INT64) int64_t bson_iter_int64 (const bson_iter_t *iter);Parametersiter A bson_iter_t \&.DescriptionFetches the value from a BSON_TYPE_INT64 field. You should verify that this is a BSON_TYPE_INT64 field before calling this…
bson_iter_int32() – Fetches the value from a BSON_TYPE_INT32 element. You should verify that the field is a BSON_TYPE_INT32 field before calling this function. Synopsis#define BSON_ITER_HOLDS_INT32(iter) \ (bson_iter_type ((iter)) == BSON_TYPE_INT32) int32_t bson_iter_int32 (const bson_iter_t *iter);Parametersiter A bson_iter_t \&.DescriptionFetches the value from a BSON_TYPE_INT32 element. You should verify that the field is a BSON_TYPE_INT32 field before…
bson_iter_init_find_case() – This function is identical to bson_iter_init() && bson_iter_find_case(). Synopsisbool bson_iter_init_find_case (bson_iter_t *iter, const bson_t *bson, const char *key);Parametersiter A bson_iter_t \&.bson A bson_t \&.key A key to locate after initializing the iter.DescriptionThis function is identical to bson_iter_init(3) && bson_iter_find_case(3) \&. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
bson_iter_init_find() – This function is identical to (bson_iter_init() && bson_iter_find()). Synopsisbool bson_iter_init_find (bson_iter_t *iter, const bson_t *bson, const char *key);Parametersiter A bson_iter_t \&.bson A bson_t \&.key A key to locate after initializing the iter.DescriptionThis function is identical to (bson_iter_init(3) && bson_iter_find(3)) \&. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
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. Synopsisbool bson_iter_init (bson_iter_t *iter, const bson_t *bson);Parametersiter A bson_iter_t \&.bson A bson_t \&.DescriptionThe bson_iter_init(3) function shall initialize iter to…
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. Synopsisbool bson_iter_find_descendant (bson_iter_t *iter, const char *dotkey, bson_iter_t *descendant);Parametersiter A bson_iter_t \&.dotkey A dot-notation key like a.b.c.d \&.descendant A…
bson_iter_find_case() – Advances iter until it is observing an element matching the name of key or exhausting all elements. Synopsisbool bson_iter_find_case (bson_iter_t *iter, const char *key);Parametersiter A bson_iter_t \&.key An ASCII string containing the field to locate.DescriptionAdvances iter until it is observing an element matching the name of key or exhausting all elements. key is…
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. Synopsisbool bson_iter_find (bson_iter_t *iter, const char *key);Parametersiter A bson_iter_t \&.key A string containing the requested key.DescriptionThe bson_iter_find(3) function shall advance iter to the element named key or exhaust…
bson_iter_dup_utf8() – This function is similar to bson_iter_utf8() except that it calls bson_strndup() on the result. Synopsischar * bson_iter_dup_utf8 (const bson_iter_t *iter, uint32_t *length);Parametersiter A bson_iter_t \&.length An optional location for the length of the UTF-8 encoded string.DescriptionThis function is similar to bson_iter_utf8(3) except that it calls bson_strndup(3) on the result. ReturnsA newly allocated string…
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);Parametersiter A bson_iter_t \&.DescriptionFetches the contents of a BSON_TYPE_DOUBLE field. ReturnsA double. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
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);Parametersiter A bson_iter_t…