NAME bson_json_reader_new() – Creates a new bson_json_reader_t that can read from an arbitrary data source in a streaming fashion. SYNOPSIS bson_json_reader_t * bson_json_reader_new (void *data, bson_json_reader_cb cb, bson_json_destroy_cb dcb, bool allow_multiple, size_t buf_size); PARAMETERS data A user-defined pointer. cb A bson_json_reader_cb. dcb A bson_json_destroy_cb. allow_multiple A bool indicating if more than one document is allowed…
NAME bson_json_reader_destroy() – Frees a bson_json_reader_t. SYNOPSIS void bson_json_reader_destroy(bson_json_reader_t *reader); PARAMETERS reader A bson_json_reader_t \&. DESCRIPTION Frees a bson_json_reader_t. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER. Index
NAME bson_json_data_reader_new() – Creates a new streaming JSON reader that will convert JSON documents to BSON. SYNOPSIS bson_json_reader_t * bson_json_data_reader_new (bool allow_multiple, size_t size); PARAMETERS allow_multiple A boolean denoting if more than one document may be allowed in the stream. size A requested buffer size. DESCRIPTION Creates a new streaming JSON reader that will convert…
NAME bson_json_data_reader_ingest() – Feed data to a memory based json reader. SYNOPSIS void bson_json_data_reader_ingest(bson_json_reader_t *reader, const uint8_t *data, size_t len); PARAMETERS reader A bson_json_reader_t \&. data A uint8_t containing data to feed. len A size_t containing the length of data \&. DESCRIPTION Feed data to a memory based json reader. COLOPHON This page is part…
NAME bson_iter_visit_all() – A convenience function to iterate all remaining fields of iter using the callback vtable provided by visitor. SYNOPSIS bool bson_iter_visit_all(bson_iter_t *iter, const bson_visitor_t *visitor, void *data); PARAMETERS iter A bson_iter_t \&. visitor A bson_visitor_t \&. data Optional data for visitor \&. DESCRIPTION A convenience function to iterate all remaining fields of iter…
NAME 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. SYNOPSIS const bson_value_t * bson_iter_value(bson_iter_t *iter); PARAMETERS iter A bson_iter_t \&. DESCRIPTION Fetches the value for the currently observed type as a boxed type. This allows passing around…
NAME 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); PARAMETERS iter A bson_iter_t \&. length An optional location for the length of the resulting UTF-8 encoded string. DESCRIPTION The bson_iter_utf8(3) function…
NAME bson_iter_type() – The bson_iter_type() function shall return the type of the observed element in a bson document. SYNOPSIS typedef 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,…
NAME 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. SYNOPSIS void bson_iter_timeval(const bson_iter_t *iter, struct timeval *tv); PARAMETERS iter A bson_iter_t \&. tv A struct timeval. DESCRIPTION The bson_iter_timeval(3) function shall return the number of seconds and microseconds…
NAME 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); PARAMETERS iter A bson_iter_t \&. timestamp A uint32_t. increment A uint32_t. DESCRIPTION The BSON_TYPE_TIMESTAMP type is not a date/time and is typically used…
NAME 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. SYNOPSIS time_t bson_iter_time_t(const bson_iter_t *iter); PARAMETERS iter A bson_iter_t \&. DESCRIPTION The 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. RETURNS A time_t…
NAME bson_iter_t – BSON Document Iterator SYNOPSIS #include <bson.h> typedef struct { /*< private >*/ } bson_iter_t; DESCRIPTION bson_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…
NAME bson_iter_symbol() – The symbol element type is DEPRECATED in the bson specification at http://bsonspec.org. SYNOPSIS const char * bson_iter_symbol(const bson_iter_t *iter, uint32_t *length); PARAMETERS iter A bson_iter_t \&. length A uint32_t. DESCRIPTION The 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…
NAME bson_iter_regex() – The bson_iter_regex() function shall retrieve the contents of a BSON_TYPE_REGEX element currently observed by iter. SYNOPSIS const char * bson_iter_regex(const bson_iter_t *iter, const char **options); PARAMETERS iter A bson_iter_t \&. options A (null). DESCRIPTION The bson_iter_regex(3) function shall retrieve the contents of a BSON_TYPE_REGEX element currently observed by iter \&. It is…
NAME bson_iter_recurse() – The bson_iter_recurse() function shall initialize child using the embedded document or array currently observed by iter. SYNOPSIS bool bson_iter_recurse (const bson_iter_t *iter, bson_iter_t *child); PARAMETERS iter A bson_iter_t \&. child A bson_iter_t \&. DESCRIPTION The bson_iter_recurse(3) function shall initialize child using the embedded document or array currently observed by iter \&. If…
NAME bson_iter_overwrite_int64() – The bson_iter_overwrite_int64() function shall overwite the contents of a BSON_TYPE_INT64 element in place. SYNOPSIS void bson_iter_overwrite_int64 (bson_iter_t *iter, int64_t value); PARAMETERS iter A bson_iter_t \&. value A int64_t. DESCRIPTION The 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…
NAME bson_iter_overwrite_int32() – The bson_iter_overwrite_int32() function shall overwrite the contents of a BSON_TYPE_INT32 element in place. SYNOPSIS void bson_iter_overwrite_int32 (bson_iter_t *iter, int32_t value); PARAMETERS iter A bson_iter_t \&. value A int32_t. DESCRIPTION The 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…
NAME bson_iter_overwrite_double() – The bson_iter_overwrite_double() function shall overwrite the contents of a BSON_TYPE_DOUBLE element in place. SYNOPSIS void bson_iter_overwrite_double(bson_iter_t *iter, double value); PARAMETERS iter A bson_iter_t \&. value The new double value. DESCRIPTION The 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…
NAME bson_iter_overwrite_bool() – The bson_iter_overwrite_bool() function shall overwrite the contents of a BSON_TYPE_BOOL element in place. SYNOPSIS void bson_iter_overwrite_bool (bson_iter_t *iter, bool value); PARAMETERS iter A bson_iter_t \&. value A bool containing the new value. DESCRIPTION The bson_iter_overwrite_bool(3) function shall overwrite the contents of a BSON_TYPE_BOOL element in place. This may only be done when…
NAME 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); PARAMETERS iter A bson_iter_t \&. DESCRIPTION Fetches the bson_oid_t for a BSON_TYPE_OID element. You should verify it is…