Linux Manuals session 3

bson_copy_to_excluding() – The bson_copy_to_excluding() function shall copy all fields from src to dst except those speified by the variadic, NULL terminated list of keys starting from first_exclude. Synopsisvoid bson_copy_to_excluding (const bson_t *src, bson_t *dst, const char *first_exclude, …) BSON_GNUC_NULL_TERMINATED;Parameterssrc A bson_t \&.dst A bson_t \&.first_exclude The first field name to exclude.DescriptionThe bson_copy_to_excluding(3) function shall copy…

bson_copy_to() – The bson_copy_to() function shall initialize dst with a copy of the contents of src. Synopsisvoid bson_copy_to (const bson_t *src, bson_t *dst);Parameterssrc A bson_t \&.dst A bson_t \&.DescriptionThe bson_copy_to(3) function shall initialize dst with a copy of the contents of src \&. dst MUST be an uninitialized bson_t to avoid leaking memory. ColophonThis page…

bson_copy() – The bson_copy() function shall copy the contents of a bson document into a new bson_t. Synopsisbson_t * bson_copy (const bson_t *bson);Parametersbson A bson_t \&.DescriptionThe bson_copy(3) function shall copy the contents of a bson document into a new bson_t \&. The resulting bson_t should be freed with bson_destroy(3) \&. ReturnsA newly allocated bson_t that…

bson_context_t – BSON OID Generation Context Synopsis#include <bson.h> typedef enum { BSON_CONTEXT_NONE = 0, BSON_CONTEXT_THREAD_SAFE = (1 << 0), BSON_CONTEXT_DISABLE_HOST_CACHE = (1 << 1), BSON_CONTEXT_DISABLE_PID_CACHE = (1 << 2), #if defined(__linux__) BSON_CONTEXT_USE_TASK_ID = (1 << 3), #endif } bson_context_flags_t; typedef struct _bson_context_t bson_context_t; bson_context_t *bson_context_get_default (void) BSON_GNUC_CONST; bson_context_t *bson_context_new (bson_context_flags_t flags); void bson_context_destroy (bson_context_t *context);DescriptionThe…

bson_context_new() – Creates a new bson_context_t. This is rarely needed as bson_context_get_default() serves most use-cases. Synopsisbson_context_t * bson_context_new (bson_context_flags_t flags);Parametersflags A bson_context_flags_t \&.DescriptionCreates a new bson_context_t \&. This is rarely needed as bson_context_get_default(3) serves most use-cases. ReturnsA newly allocated bson_context_t that should be freed with bson_context_destroy \&. ColophonThis page is part of libbson. Please report…

bson_context_get_default() – None Synopsisbson_context_t * bson_context_get_default (void) BSON_GNUC_CONST;ReturnsThe bson_context_get_default(3) function shall return the default, thread-safe, bson_context_t for the process. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

bson_context_destroy() – The bson_context_destroy() function shall release all resources associated with context. Synopsisvoid bson_context_destroy (bson_context_t *context);Parameterscontext A bson_context_t \&.DescriptionThe bson_context_destroy(3) function shall release all resources associated with context \&. This should be called when you are no longer using a bson_context_t that you have allocated with bson_context_new(3) \&. ColophonThis page is part of libbson. Please…

bson_concat() – The bson_concat() function shall append the contents of src to dst. Synopsisbool bson_concat (bson_t *dst, const bson_t *src);Parametersdst A bson_t \&.src A bson_t \&.DescriptionThe bson_concat(3) function shall append the contents of src to dst \&. Returnstrue if the operation was applied successfully, otherwise false and dst should be discarded. ColophonThis page is part…

bson_compare() – The bson_compare() function shall compare two bson documents for equality. Synopsisint bson_compare (const bson_t *bson, const bson_t *other);Parametersbson A bson_t \&.other A bson_t \&.DescriptionThe bson_compare(3) function shall compare two bson documents for equality. This can be useful in conjunction with _qsort()_. If equal, 0 is returned. NOTE This function uses _memcmp()_ internally, so…

bson_check_version() – Check at runtime if this release of libbson meets a required version. Synopsisbool bson_check_version (int required_major, int required_minor, int required_micro);Parametersrequired_major The minimum major version required.required_minor The minimum minor version required.required_micro The minimum micro version required.DescriptionCheck at runtime if this release of libbson meets a required version. ReturnsTrue if libbson’s version is greater than…

bson_as_json() – The bson_as_json() function shall encode bson as a JSON encoded UTF-8 string. Synopsischar * bson_as_json (const bson_t *bson, size_t *length);Parametersbson A bson_t \&.length An optional location for the length of the resulting string.DescriptionThe bson_as_json(3) function shall encode bson as a JSON encoded UTF-8 string. The caller is responsible for freeing the resulting UTF-8…

bson_append_value() – Appends a new field to bson by determining the boxed type in value. This is useful if you want to copy fields between documents but do not know the field type until runtime. Synopsisbool bson_append_value (bson_t *bson, const char *key, int key_length, const bson_value_t *value);Parametersbson A bson_t \&.key An ASCII C string containing…

bson_append_utf8() – The bson_append_utf8() function shall append a UTF-8 encoded string to bson. Synopsisbool bson_append_utf8 (bson_t *bson, const char *key, int key_length, const char *value, int length);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of key in bytes, or -1 to determine the length with strlen(3) \&.value…

bson_append_undefined() – The bson_append_undefined() function shall append a new element to bson of type BSON_TYPE_UNDEFINED. Undefined is common in Javascript. However, this element type is deprecated and should not be used in new code. Synopsisbool bson_append_undefined (bson_t *bson, const char *key, int key_length);Parametersbson A bson_t \&.key An ASCII C string containing the name of the…

bson_append_timeval() – The bson_append_timeval() function is a helper that takes a _struct timeval_ instead of milliseconds since the UNIX epoch. Synopsisbool bson_append_timeval (bson_t *bson, const char *key, int key_length, struct timeval *value);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of key in bytes, or -1 to determine…

bson_append_timestamp() – This function is not similar in functionality to bson_append_date_time(). Timestamp elements are different in that they include only second precision and an increment field. Synopsisbool bson_append_timestamp (bson_t *bson, const char *key, int key_length, uint32_t timestamp, uint32_t increment);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of…

bson_append_time_t() – The bson_append_time_t() function is a helper that takes a time_t instead of milliseconds since the UNIX epoch. Synopsisbool bson_append_time_t (bson_t *bson, const char *key, int key_length, time_t value);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of key in bytes, or -1 to determine the length…

bson_append_symbol() – Appends a new field to bson of type BSON_TYPE_SYMBOL. This BSON type is deprecated and should not be used in new code. Synopsisbool bson_append_symbol (bson_t *bson, const char *key, int key_length, const char *value, int length);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of key…

bson_append_regex() – Appends a new field to bson of type BSON_TYPE_REGEX. regex should be the regex string. options should contain the options for the regex. Synopsisbool bson_append_regex (bson_t *bson, const char *key, int key_length, const char *regex, const char *options);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length…

bson_append_oid() – The bson_append_oid() function shall append a new element to bson of type BSON_TYPE_OID. oid MUST be a pointer to a bson_oid_t. Synopsisbool bson_append_oid (bson_t *bson, const char *key, int key_length, const bson_oid_t *oid);Parametersbson A bson_t \&.key An ASCII C string containing the name of the field.key_length The length of key in bytes, or…