Section 3: library functions
bson_json_data_reader_new() – Creates a new streaming JSON reader that will convert JSON documents to BSON. Synopsisbson_json_reader_t * bson_json_data_reader_new (bool allow_multiple, size_t size);Parametersallow_multiple A boolean denoting if more than one document may be allowed in the stream.size A requested buffer size.DescriptionCreates a new streaming JSON reader that will convert JSON documents to BSON. ReturnsA newly allocated…
bson_json_data_reader_ingest() – Feed data to a memory based json reader. Synopsisvoid bson_json_data_reader_ingest (bson_json_reader_t *reader, const uint8_t *data, size_t len);Parametersreader A bson_json_reader_t \&.data A uint8_t containing data to feed.len A size_t containing the length of data \&.DescriptionFeed data to a memory based json reader. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
bson_iter_visit_all() – A convenience function to iterate all remaining fields of iter using the callback vtable provided by visitor. Synopsisbool bson_iter_visit_all (bson_iter_t *iter, const bson_visitor_t *visitor, void *data);Parametersiter A bson_iter_t \&.visitor A bson_visitor_t \&.data Optional data for visitor \&.DescriptionA convenience function to iterate all remaining fields of iter using the callback vtable provided by visitor…
bson_iter_value() – Fetches the value for the currently observed type as a boxed type. This allows passing around the value without knowing the type at runtime. Synopsisconst bson_value_t * bson_iter_value (bson_iter_t *iter);Parametersiter A bson_iter_t \&.DescriptionFetches the value for the currently observed type as a boxed type. This allows passing around the value without knowing the…
bson_iter_utf8() – The bson_iter_utf8() function shall retrieve the contents of a BSON_TYPE_UTF8 element currently observed by iter. Synopsis#define BSON_ITER_HOLDS_UTF8(iter) \ (bson_iter_type ((iter)) == BSON_TYPE_UTF8) const char * bson_iter_utf8 (const bson_iter_t *iter, uint32_t *length);Parametersiter A bson_iter_t \&.length An optional location for the length of the resulting UTF-8 encoded string.DescriptionThe bson_iter_utf8(3) function shall retrieve the contents of…
bson_iter_type() – The bson_iter_type() function shall return the type of the observed element in a bson document. Synopsistypedef enum { BSON_TYPE_EOD = 0x00, BSON_TYPE_DOUBLE = 0x01, BSON_TYPE_UTF8 = 0x02, BSON_TYPE_DOCUMENT = 0x03, BSON_TYPE_ARRAY = 0x04, BSON_TYPE_BINARY = 0x05, BSON_TYPE_UNDEFINED = 0x06, BSON_TYPE_OID = 0x07, BSON_TYPE_BOOL = 0x08, BSON_TYPE_DATE_TIME = 0x09, BSON_TYPE_NULL = 0x0A, BSON_TYPE_REGEX =…
bson_iter_timeval() – The bson_iter_timeval() function shall return the number of seconds and microseconds since the UNIX epoch, as contained in the BSON_TYPE_DATE_TIME element into tv. Synopsisvoid bson_iter_timeval (const bson_iter_t *iter, struct timeval *tv);Parametersiter A bson_iter_t \&.tv A struct timeval.DescriptionThe bson_iter_timeval(3) function shall return the number of seconds and microseconds since the UNIX epoch, as contained…
bson_iter_timestamp() – The BSON_TYPE_TIMESTAMP type is not a date/time and is typically used for intra-server communication. Synopsis#define BSON_ITER_HOLDS_TIMESTAMP(iter) \ (bson_iter_type ((iter)) == BSON_TYPE_TIMESTAMP) void bson_iter_timestamp (const bson_iter_t *iter, uint32_t *timestamp, uint32_t *increment);Parametersiter A bson_iter_t \&.timestamp A uint32_t.increment A uint32_t.DescriptionThe BSON_TYPE_TIMESTAMP type is not a date/time and is typically used for intra-server communication. You probably want…
bson_iter_time_t() – The bson_iter_time_t() function shall return the number of seconds since the UNIX epoch, as contained in the BSON_TYPE_DATE_TIME element. Synopsistime_t bson_iter_time_t (const bson_iter_t *iter);Parametersiter A bson_iter_t \&.DescriptionThe bson_iter_time_t(3) function shall return the number of seconds since the UNIX epoch, as contained in the BSON_TYPE_DATE_TIME element. ReturnsA time_t containing the number of seconds since…
bson_iter_t – BSON Document Iterator Synopsis#include <bson.h> typedef struct { /*< private >*/ } bson_iter_t;Descriptionbson_iter_t is a structure used to iterate through the elements of a bson_t \&. It is meant to be used on the stack and can be discarded at any time as it contains no external allocation. The contents of the structure…
bson_iter_symbol() – The symbol element type is DEPRECATED in the bson specification at http://bsonspec.org. Synopsisconst char * bson_iter_symbol (const bson_iter_t *iter, uint32_t *length);Parametersiter A bson_iter_t \&.length A uint32_t.DescriptionThe symbol element type is DEPRECATED in the bson specification at http://bsonspec.org. The bson_iter_symbol(3) function shall return the contents of a BSON_TYPE_SYMBOL element. if non-NULL, length will be…
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.