Section 3: library functions
NAME bson_new_from_buffer() – TODO: SYNOPSIS bson_t * bson_new_from_buffer (uint8_t **buf, size_t *buf_len, bson_realloc_func realloc_func, void *realloc_func_ctx); PARAMETERS buf A uint8_t. buf_len A size_t. realloc_func A bson_realloc_func. realloc_func_ctx A (null). DESCRIPTION TODO: RETURNS TODO: COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER. Index
NAME bson_new() – The bson_new() function shall create a new bson_t structure on the heap. It should be freed with bson_destroy() when it is no longer in use. SYNOPSIS bson_t * bson_new(void); DESCRIPTION The bson_new(3) function shall create a new bson_t structure on the heap. It should be freed with bson_destroy(3) when it is no…
NAME bson_mem_set_table() – This function shall install a new memory allocator to be used by Libbson. SYNOPSIS typedef struct _bson_mem_vtable_t { void *(*malloc)(size_t num_bytes); void *(*calloc)(size_t n_members, size_t num_bytes); void *(*realloc)(void *mem, size_t num_bytes); void (*free)(void *mem); void *padding[4]; } bson_mem_vtable_t; void bson_mem_set_vtable(const bson_mem_vtable_t *vtable); PARAMETERS vtable A bson_mem_vtable_t with every non-padding field set. DESCRIPTION…
NAME bson_mem_restore_vtable() – This function shall restore the default memory allocator to be used by Libbson. SYNOPSIS void bson_mem_restore_vtable(void); DESCRIPTION This function shall restore the default memory allocator to be used by Libbson. NOTE This function MUST be called at the end of the process. Failure to do so will result in memory being freed…
NAME bson_md5_t – BSON MD5 Abstraction SYNOPSIS typedef struct { uint32_t count[2]; /* message length in bits, lsw first */ uint32_t abcd[4]; /* digest buffer */ uint8_t buf[64]; /* accumulate block */ } bson_md5_t; DESCRIPTION bson_md5_t encapsulates an implementation of the MD5 algorithm. This is used in OID generation for the MD5(hostname) bytes. It is…
NAME bson_md5_init() – Initialize a new instance of the MD5 algorithm. SYNOPSIS void bson_md5_init(bson_md5_t *pms); PARAMETERS pms A bson_md5_t \&. DESCRIPTION Initialize a new instance of the MD5 algorithm. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER. Index
NAME bson_md5_finish() – Completes the MD5 algorithm and stores the digest in digest. SYNOPSIS void bson_md5_finish(bson_md5_t *pms, uint8_t digest[16]); PARAMETERS pms A bson_md5_t \&. digest A location for the digest. DESCRIPTION Completes the MD5 algorithm and stores the digest in digest \&. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER….
NAME bson_md5_append() – Feeds more data into the MD5 algorithm. SYNOPSIS void bson_md5_append(bson_md5_t *pms, const uint8_t *data, uint32_t nbytes); PARAMETERS pms A bson_md5_t \&. data A memory region to feed to the md5 algorithm. nbytes The length of data in bytes. DESCRIPTION Feeds more data into the MD5 algorithm. COLOPHON This page is part of…
NAME bson_malloc0() – This is a portable malloc() wrapper that also sets the memory to zero. Similar to calloc(). SYNOPSIS void * bson_malloc0(size_t num_bytes); PARAMETERS num_bytes A size_t. DESCRIPTION This is a portable malloc(3) wrapper that also sets the memory to zero. Similar to calloc(3) \&. In general, this function will return an allocation at…
NAME bson_malloc() – This is a portable malloc() wrapper. SYNOPSIS void * bson_malloc(size_t num_bytes); PARAMETERS num_bytes A size_t containing the number of bytes to allocate. DESCRIPTION This is a portable malloc(3) wrapper. In general, this function will return an allocation at least sizeof(void*) bytes or bigger. If there was a failure to allocate num_bytes bytes,…
NAME bson_json_reader_t – Bulk JSON to BSON conversion SYNOPSIS #include <bson.h> typedef struct _bson_json_reader_t bson_json_reader_t; typedef enum { BSON_JSON_ERROR_READ_CORRUPT_JS = 1, BSON_JSON_ERROR_READ_INVALID_PARAM, BSON_JSON_ERROR_READ_CB_FAILURE, } bson_json_error_code_t; DESCRIPTION The bson_json_reader_t structure is used for reading a sequence of JSON documents and transforming them to bson_t documents. This can often be useful if you want to perform bulk…
NAME bson_json_reader_read() – Reads the next BSON document from the underlying JSON source. SYNOPSIS int bson_json_reader_read (bson_json_reader_t *reader, bson_t *bson, bson_error_t *error); PARAMETERS reader A bson_json_reader_t \&. bson A bson_t \&. error A bson_error_t \&. DESCRIPTION Reads the next BSON document from the underlying JSON source. ERRORS Errors are propagated via the error parameter. RETURNS…
NAME bson_json_reader_new_from_file() – Creates a new bson_json_reader_t using the underlying file found at filename. SYNOPSIS bson_json_reader_t * bson_json_reader_new_from_file(const char *filename, bson_error_t *error); PARAMETERS filename A file-name in the system file-name encoding. error A bson_error_t \&. DESCRIPTION Creates a new bson_json_reader_t using the underlying file found at filename \&. ERRORS Errors are propagated via error \&….
NAME bson_json_reader_new_from_fd() – Creates a new JSON to BSON converter that will be reading from the file-descriptor fd. SYNOPSIS bson_json_reader_t * bson_json_reader_new_from_fd (int fd, bool close_on_destroy); PARAMETERS fd An open file-descriptor. close_on_destroy Whether close(3) should be called on fd when the reader is destroyed. DESCRIPTION Creates a new JSON to BSON converter that will be…
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…