Section 3: library functions
bson_utf8_escape_for_json() – Escapes the string utf8 to be placed inside of a JSON string. Synopsischar * bson_utf8_escape_for_json (const char *utf8, ssize_t utf8_len);Parametersutf8 A UTF-8 encoded string.utf8_len The length of utf8 in bytes or -1 if it is NULL terminated.DescriptionEscapes the string utf8 to be placed inside of a JSON string. ReturnsA newly allocated string that…
bson_unichar_t – Unicode Character Abstraction Synopsistypedef uint32_t bson_unichar_t;Descriptionbson_unichar_t provides an abstraction on a single unicode character. It is the 32-bit representation of a character. As UTF-8 can contain multi-byte characters, this should be used when iterating through UTF-8 text. Examplestatic void print_each_char (const char *str) { bson_unichar_t c; for (; *str; str = bson_utf8_next_char (str))…
bson_uint32_to_string() – Converts value to a string. Synopsissize_t bson_uint32_to_string (uint32_t value, const char **strptr, char *str, size_t size);Parametersvalue A uint32_t.strptr A location for the resulting string pointer.str A location to buffer the string.size A size_t containing the size of str \&.DescriptionConverts value to a string. If value is from 0 to 999, it will use…
bson_type_t – BSON Type Enumeration Synopsis#include <bson.h> 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, BSON_TYPE_REGEX = 0x0B, BSON_TYPE_DBPOINTER = 0x0C, BSON_TYPE_CODE = 0x0D, BSON_TYPE_SYMBOL = 0x0E,…
bson_t – BSON Document Abstraction Synopsis#include <bson.h> BSON_ALIGNED_BEGIN (128) typedef struct { uint32_t flags; /* Internal flags for the bson_t. */ uint32_t len; /* Length of BSON data. */ uint8_t padding[120]; /* Padding for stack allocation. */ } bson_t BSON_ALIGNED_END (128);DescriptionThe bson_t structure represents a BSON document. This structure manages the underlying BSON encoded buffer….
bson_subtype_t – Binary Field Subtype Synopsis#include <bson.h> typedef enum { BSON_SUBTYPE_BINARY = 0x00, BSON_SUBTYPE_FUNCTION = 0x01, BSON_SUBTYPE_BINARY_DEPRECATED = 0x02, BSON_SUBTYPE_UUID_DEPRECATED = 0x03, BSON_SUBTYPE_UUID = 0x04, BSON_SUBTYPE_MD5 = 0x05, BSON_SUBTYPE_USER = 0x80, } bson_subtype_t;DescriptionThis enumeration contains the various subtypes that may be used in a binary field. See http://bsonspec.org for more information. Examplebson_t doc = BSON_INITIALIZER;…
bson_strnlen() – A portable version of strnlen(). Synopsissize_t bson_strnlen (const char *s, size_t maxlen);Parameterss A string.maxlen The maximum size of string to check.DescriptionA portable version of strnlen(3) \&. ReturnsThe length of s in bytes or maxlen if no \0 was found. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
bson_strndup() – Allocates a new string and copies up to n_bytes from str into it. A trailing is always set. Synopsischar * bson_strndup (const char *str, size_t n_bytes);Parametersstr A string to copy.n_bytes A size_t.DescriptionAllocates a new string and copies up to n_bytes from str into it. A trailing \0 is always set. ReturnsA newly…
bson_strncpy() – Copies up to size bytes from src into dst. dst must be at least size bytes in size. A trailing will be set. Synopsisvoid bson_strncpy (char *dst, const char *src, size_t size);Parametersdst The destination buffer.src The src buffer.size The number of bytes to copy into dst, which must be at least that…
bson_string_truncate() – Truncates the string so that it is len bytes in length. This must be smaller or equal to the current length of the string. Synopsisvoid bson_string_truncate (bson_string_t *string, uint32_t len);Parametersstring A bson_string_t \&.len The new length of the string, excluding the trailing \0 \&.DescriptionTruncates the string so that it is len bytes in…
bson_string_t – String Building Abstraction Synopsis#include <bson.h> typedef struct { char *str; uint32_t len; uint32_t alloc; } bson_string_t;Descriptionbson_string_t is an abstraction for building strings. As chunks are added to the string, allocations are performed in powers of two. This API is useful if you need to build UTF-8 encoded strings. Examplebson_string_t *str; str = bson_string_new…
bson_string_new() – Creates a new string builder, which uses power-of-two growth of buffers. Use the various bson_string_append*() functions to append to the string. Synopsisbson_string_t * bson_string_new (const char *str);Parametersstr A string to be copied or NULL.DescriptionCreates a new string builder, which uses power-of-two growth of buffers. Use the various bson_string_append*() functions to append to the…
bson_string_free() – Frees the bson_string_t structure and optionally the string itself. Synopsischar * bson_string_free (bson_string_t *string, bool free_segment);Parametersstring A bson_string_t \&.free_segment A bool indicating if str->str should be returned.DescriptionFrees the bson_string_t structure and optionally the string itself. Returnsstr->str if free_segment is true, otherwise NULL. ColophonThis page is part of libbson. Please report any bugs at…
bson_string_append_unichar() – Appends a unicode character to string. The character will be encoded into its multi-byte UTF-8 representation. Synopsisvoid bson_string_append_unichar (bson_string_t *string, bson_unichar_t unichar);Parametersstring A bson_string_t \&.unichar A bson_unichar_t \&.DescriptionAppends a unicode character to string. The character will be encoded into its multi-byte UTF-8 representation. ColophonThis page is part of libbson. Please report any bugs…
bson_string_append_printf() – Like bson_string_append() but formats a printf style string and then appends that to string. Synopsisvoid bson_string_append_printf (bson_string_t *string, const char *format, …) BSON_GNUC_PRINTF (2, 3);Parametersstring A bson_string_t \&.format A printf style format string.DescriptionLike bson_string_append() but formats a printf style string and then appends that to string \&. ColophonThis page is part of libbson….
bson_string_append_c() – Appends c to the string builder string. Synopsisvoid bson_string_append_c (bson_string_t *string, char str);Parametersstring A bson_string_t \&.str An ASCII char.DescriptionAppends c to the string builder string \&. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
bson_string_append() – Appends the ASCII or UTF-8 encoded string str to string. This is not suitable for embedding NULLs in strings. Synopsisvoid bson_string_append (bson_string_t *string, const char *str);Parametersstring A bson_string_t \&.str A string.DescriptionAppends the ASCII or UTF-8 encoded string str to string \&. This is not suitable for embedding NULLs in strings. ColophonThis page is…
bson_strfreev() – This will free each string in a NULL-terminated array of strings and then the array itself. Synopsisvoid bson_strfreev (char **strv);Parametersstrv A NULL-terminated array of strings to free, including the array.DescriptionThis will free each string in a NULL-terminated array of strings and then the array itself. ColophonThis page is part of libbson. Please report…
bson_strerror_r() – This is a portability wrapper around strerror(). Synopsischar * bson_strerror_r (int err_code, char *buf, size_t buflen);Parameterserr_code An errno.buf A location to store the string.buflen The size of buf \&.DescriptionThis is a portability wrapper around strerror(3) \&. ReturnsThe passed in buf parameter or an internal string. ColophonThis page is part of libbson. Please report…
bson_strdupv_printf() – This function is like bson_strdup_printf() except takes a va_list of parameters. Synopsischar * bson_strdupv_printf (const char *format, va_list args) BSON_GNUC_PRINTF (1, 0);Parametersformat A printf style format string.args A va_list.DescriptionThis function is like bson_strdup_printf(3) except takes a va_list of parameters. ReturnsA newly allocated string that should be freed with bson_free(). ColophonThis page is part…