bson_oid_get_time_t() – Fetches the generation time in seconds since the UNIX Epoch of oid. Synopsistime_t bson_oid_get_time_t (const bson_oid_t *oid);Parametersoid A bson_oid_t \&.DescriptionFetches the generation time in seconds since the UNIX Epoch of oid \&. ReturnsA time_t containing the seconds since the UNIX epoch of oid \&. ColophonThis page is part of libbson. Please report any…
bson_oid_equal() – Checks if two bson_oid_t contain the same bytes. Synopsisbool bson_oid_equal (const bson_oid_t *oid1, const bson_oid_t *oid2);Parametersoid1 A bson_oid_t \&.oid2 A bson_oid_t \&.DescriptionChecks if two bson_oid_t contain the same bytes. Returnstrue if they are equal, otherwise false. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
bson_oid_copy() – Copies the contents of src into dst. Synopsisvoid bson_oid_copy (const bson_oid_t *src, bson_oid_t *dst);Parameterssrc A bson_oid_t \&.dst A bson_oid_t \&.DescriptionCopies the contents of src into dst. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
bson_oid_compare() – The bson_oid_compare() function shall return a qsort() style value of a lexicographical sort of _oid1_ and _oid2_. Synopsisint bson_oid_compare (const bson_oid_t *oid1, const bson_oid_t *oid2);Parametersoid1 A bson_oid_t \&.oid2 A bson_oid_t \&.DescriptionThe bson_oid_compare(3) function shall return a qsort() style value of a lexicographical sort of _oid1_ and _oid2_. Returnsless than 0, 0, or greater…
bson_new_from_json() – The bson_new_from_json() function allocates and 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 NULL returned. Synopsisbson_t * bson_new_from_json (const uint8_t *data, ssize_t len, bson_error_t *error);Parametersdata A UTF-8 encoded string containing valid JSON.len The length…
bson_new_from_data() – The bson_new_from_data() function shall create a new bson_t on the heap and copy the contents of data. This may be helpful when working with language bindings but is generally expected to be slower. Synopsisbson_t * bson_new_from_data (const uint8_t *data, size_t length);Parametersdata A BSON encoded document buffer.length The length of data in bytes.DescriptionThe bson_new_from_data(3)…
bson_new_from_buffer() – TODO: Synopsisbson_t * bson_new_from_buffer (uint8_t **buf, size_t *buf_len, bson_realloc_func realloc_func, void *realloc_func_ctx);Parametersbuf A uint8_t.buf_len A size_t.realloc_func A bson_realloc_func.realloc_func_ctx A (null).DescriptionTODO: ReturnsTODO: ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
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. Synopsisbson_t * bson_new (void);DescriptionThe 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 longer in use….
bson_mem_set_table() – This function shall install a new memory allocator to be used by Libbson. Synopsistypedef 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);Parametersvtable A bson_mem_vtable_t with every non-padding field…
bson_mem_restore_vtable() – This function shall restore the default memory allocator to be used by Libbson. Synopsisvoid bson_mem_restore_vtable (void);DescriptionThis 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 by the wrong…
bson_md5_t – BSON MD5 Abstraction Synopsistypedef 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;Descriptionbson_md5_t encapsulates an implementation of the MD5 algorithm. This is used in OID generation for the MD5(hostname) bytes. It is also used by some…
bson_md5_init() – Initialize a new instance of the MD5 algorithm. Synopsisvoid bson_md5_init (bson_md5_t *pms);Parameterspms A bson_md5_t \&.DescriptionInitialize a new instance of the MD5 algorithm. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
bson_md5_finish() – Completes the MD5 algorithm and stores the digest in digest. Synopsisvoid bson_md5_finish (bson_md5_t *pms, uint8_t digest[16]);Parameterspms A bson_md5_t \&.digest A location for the digest.DescriptionCompletes the MD5 algorithm and stores the digest in digest \&. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
bson_md5_append() – Feeds more data into the MD5 algorithm. Synopsisvoid bson_md5_append (bson_md5_t *pms, const uint8_t *data, uint32_t nbytes);Parameterspms A bson_md5_t \&.data A memory region to feed to the md5 algorithm.nbytes The length of data in bytes.DescriptionFeeds more data into the MD5 algorithm. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
bson_malloc0() – This is a portable malloc() wrapper that also sets the memory to zero. Similar to calloc(). Synopsisvoid * bson_malloc0 (size_t num_bytes);Parametersnum_bytes A size_t.DescriptionThis 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 least sizeof(void*) bytes or bigger….
bson_malloc() – This is a portable malloc() wrapper. Synopsisvoid * bson_malloc (size_t num_bytes);Parametersnum_bytes A size_t containing the number of bytes to allocate.DescriptionThis 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, the process will be aborted….
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;DescriptionThe 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 operations that are defined…
bson_json_reader_read() – Reads the next BSON document from the underlying JSON source. Synopsisint bson_json_reader_read (bson_json_reader_t *reader, bson_t *bson, bson_error_t *error);Parametersreader A bson_json_reader_t \&.bson A bson_t \&.error A bson_error_t \&.DescriptionReads the next BSON document from the underlying JSON source. ErrorsErrors are propagated via the error parameter. Returns1 if successful and data was read. 0 if successful…
bson_json_reader_new_from_file() – Creates a new bson_json_reader_t using the underlying file found at filename. Synopsisbson_json_reader_t * bson_json_reader_new_from_file (const char *filename, bson_error_t *error);Parametersfilename A file-name in the system file-name encoding.error A bson_error_t \&.DescriptionCreates a new bson_json_reader_t using the underlying file found at filename \&. ErrorsErrors are propagated via error \&. ReturnsA newly allocated bson_json_reader_t if successful, otherwise…
bson_json_reader_new_from_fd() – Creates a new JSON to BSON converter that will be reading from the file-descriptor fd. Synopsisbson_json_reader_t * bson_json_reader_new_from_fd (int fd, bool close_on_destroy);Parametersfd An open file-descriptor.close_on_destroy Whether close(3) should be called on fd when the reader is destroyed.DescriptionCreates a new JSON to BSON converter that will be reading from the file-descriptor fd \&. ReturnsA…