Section 3: library functions
NAME bson_reader_new_from_handle() – This function allows for a pluggable data stream for the reader. This can be used to read from sockets, files, memory, or other arbitrary sources. SYNOPSIS bson_reader_t * bson_reader_new_from_handle (void *handle, bson_reader_read_func_t rf, bson_reader_destroy_func_t df); PARAMETERS handle A user-provided pointer or NULL. rf A bson_reader_read_func_t \&. df A bson_reader_destroy_func_t \&. DESCRIPTION This…
NAME bson_reader_new_from_file() – Creates a new bson_reader_t using the file denoted by filename. SYNOPSIS bson_reader_t * bson_reader_new_from_file(const char *path, bson_error_t *error); PARAMETERS path A filename in the host filename encoding. error A bson_error_t \&. DESCRIPTION Creates a new bson_reader_t using the file denoted by filename \&. ERRORS Errors are propagated via the error parameter. RETURNS…
NAME bson_reader_new_from_fd() – The bson_reader_new_from_fd() function shall create a new bson_reader_t that will read from the provided file-descriptor. SYNOPSIS bson_reader_t * bson_reader_new_from_fd (int fd, bool close_on_destroy); PARAMETERS fd A valid file-descriptor. close_on_destroy Whether close(3) should be called on fd when the reader is destroyed. DESCRIPTION The bson_reader_new_from_fd(3) function shall create a new bson_reader_t that will…
NAME bson_reader_new_from_data() – The bson_reader_new_from_data() function shall create a new bson_reader_t using the buffer supplied. data is not copied and MUST be valid for the lifetime of the resulting bson_reader_t. SYNOPSIS bson_reader_t * bson_reader_new_from_data (const uint8_t *data, size_t length); PARAMETERS data A uint8_t. length A size_t. DESCRIPTION The bson_reader_new_from_data(3) function shall create a new bson_reader_t…
NAME bson_reader_destroy_func_t – An optional callback function that will be called when a bson_reader_t created with bson_reader_new_from_handle is destroyed with bson_reader_destroy(). SYNOPSIS typedef void (*bson_reader_destroy_func_t)(void *handle); PARAMETERS handle The opaque handle provided to bson_reader_new_from_handle \&. DESCRIPTION An optional callback function that will be called when a bson_reader_t created with bson_reader_new_from_handle is destroyed with bson_reader_destroy(3) \&….
NAME bson_reader_destroy() – Destroys and releases all resources associated with reader. SYNOPSIS void bson_reader_destroy(bson_reader_t *reader); PARAMETERS reader A bson_reader_t \&. DESCRIPTION Destroys and releases all resources associated with reader \&. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER. Index
NAME bson_oid_to_string() – Converts oid into a hex encoded string. SYNOPSIS void bson_oid_to_string(const bson_oid_t *oid, char str[25]); PARAMETERS oid A bson_oid_t \&. str A location for the resulting string. DESCRIPTION Converts oid into a hex encoded string. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER. Index
NAME bson_oid_t – BSON ObjectID Abstraction SYNOPSIS #include <bson.h> typedef struct { uint8_t bytes[12]; } bson_oid_t; DESCRIPTION The bson_oid_t structure contains the 12-byte ObjectId notation defined by the BSON ObjectID specificiation \&. ObjectId is a 12-byte BSON type, constructed using: \[bu] a 4-byte value representing the seconds since the Unix epoch (in Big Endian) \[bu]…
NAME bson_oid_is_valid() – Checks if a string containing a hex encoded string is a valid BSON ObjectID. SYNOPSIS bool bson_oid_is_valid(const char *str, size_t length); PARAMETERS str A string. length The length of str \&. DESCRIPTION Checks if a string containing a hex encoded string is a valid BSON ObjectID. RETURNS true if str could be…
NAME bson_oid_init_sequence() – Generates a new ObjectID using the 64-bit sequence. SYNOPSIS void bson_oid_init_sequence (bson_oid_t *oid, bson_context_t *context); PARAMETERS oid A bson_oid_t \&. context An optional bson_context_t \&. DESCRIPTION Generates a new ObjectID using the 64-bit sequence. NOTE This form of ObjectID is generally used by MongoDB replica peers only. COLOPHON This page is part…
NAME bson_oid_init_from_string() – Parses the string containing hex encoded oid and initialize the bytes in oid. SYNOPSIS void bson_oid_init_from_string(bson_oid_t *oid, const char *str); PARAMETERS oid A bson_oid_t \&. str A string containing a hex encoded version of the oid. DESCRIPTION Parses the string containing hex encoded oid and initialize the bytes in oid \&. EXAMPLE…
NAME bson_oid_init_from_data() – Initializes a bson_oid_t using the raw buffer provided. SYNOPSIS void bson_oid_init_from_data(bson_oid_t *oid, const uint8_t *data); PARAMETERS oid A bson_oid_t \&. data A buffer containing 12 bytes for the oid. DESCRIPTION Initializes a bson_oid_t using the raw buffer provided. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER. Index
NAME bson_oid_init() – Generates a new bson_oid_t using either context or the default bson_context_t. SYNOPSIS void bson_oid_init (bson_oid_t *oid, bson_context_t *context); PARAMETERS oid A bson_oid_t \&. context An optional bson_context_t or NULL. DESCRIPTION Generates a new bson_oid_t using either context or the default bson_context_t \&. COLOPHON This page is part of libbson. Please report any…
NAME bson_oid_hash() – Generates a hash code for oid suitable for a hashtable. SYNOPSIS uint32_t bson_oid_hash(const bson_oid_t *oid); PARAMETERS oid A bson_oid_t \&. DESCRIPTION Generates a hash code for oid suitable for a hashtable. RETURNS A 32-bit hash code. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER. Index
NAME bson_oid_get_time_t() – Fetches the generation time in seconds since the UNIX Epoch of oid. SYNOPSIS time_t bson_oid_get_time_t(const bson_oid_t *oid); PARAMETERS oid A bson_oid_t \&. DESCRIPTION Fetches the generation time in seconds since the UNIX Epoch of oid \&. RETURNS A time_t containing the seconds since the UNIX epoch of oid \&. COLOPHON This page…
NAME bson_oid_equal() – Checks if two bson_oid_t contain the same bytes. SYNOPSIS bool bson_oid_equal(const bson_oid_t *oid1, const bson_oid_t *oid2); PARAMETERS oid1 A bson_oid_t \&. oid2 A bson_oid_t \&. DESCRIPTION Checks if two bson_oid_t contain the same bytes. RETURNS true if they are equal, otherwise false. COLOPHON This page is part of libbson. Please report any…
NAME bson_oid_copy() – Copies the contents of src into dst. SYNOPSIS void bson_oid_copy(const bson_oid_t *src, bson_oid_t *dst); PARAMETERS src A bson_oid_t \&. dst A bson_oid_t \&. DESCRIPTION Copies the contents of src into dst. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER. Index
NAME bson_oid_compare() – The bson_oid_compare() function shall return a qsort() style value of a lexicographical sort of _oid1_ and _oid2_. SYNOPSIS int bson_oid_compare(const bson_oid_t *oid1, const bson_oid_t *oid2); PARAMETERS oid1 A bson_oid_t \&. oid2 A bson_oid_t \&. DESCRIPTION The bson_oid_compare(3) function shall return a qsort() style value of a lexicographical sort of _oid1_ and _oid2_….
NAME 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. SYNOPSIS bson_t * bson_new_from_json (const uint8_t *data, ssize_t len, bson_error_t *error); PARAMETERS data A UTF-8 encoded string containing…
NAME 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. SYNOPSIS bson_t * bson_new_from_data (const uint8_t *data, size_t length); PARAMETERS data A BSON encoded document buffer. length The length…