Linux Manuals session 3

bson_writer_new() – Creates a new instance of bson_writer_t using the buffer, length, offset, and _realloc()_ function supplied. Synopsisbson_writer_t * bson_writer_new (uint8_t **buf, size_t *buflen, size_t offset, bson_realloc_func realloc_func, void *realloc_func_ctx);Parametersbuf A uint8_t.buflen A size_t.offset A size_t.realloc_func A bson_realloc_func.realloc_func_ctx A bson_realloc_func.DescriptionCreates a new instance of bson_writer_t using the buffer , length , offset , and _realloc()_…

bson_writer_get_length() – Fetches the current length of the content written by the buffer (including the initial offset). This includes a partly written document currently being written. Synopsissize_t bson_writer_get_length (bson_writer_t *writer);Parameterswriter A bson_writer_t \&.DescriptionFetches the current length of the content written by the buffer (including the initial offset). This includes a partly written document currently being…

bson_writer_end() – Complete writing of a bson_writer_t to the buffer supplied. Synopsisvoid bson_writer_end (bson_writer_t *writer);Parameterswriter A bson_writer_t \&.DescriptionComplete writing of a bson_writer_t to the buffer supplied. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

bson_writer_destroy() – Cleanup after writer and release any allocated memory. Note that the buffer supplied to bson_writer_new() is NOT freed from this method. The caller is responsible for that. Synopsisvoid bson_writer_destroy (bson_writer_t *writer);Parameterswriter A bson_writer_t \&.DescriptionCleanup after writer and release any allocated memory. Note that the buffer supplied to bson_writer_new(3) is NOT freed from this…

bson_writer_begin() – Begins writing a new document. The caller may use the bson structure to write out a new BSON document. When completed, the caller must call either bson_writer_end() or bson_writer_rollback(). Synopsisbool bson_writer_begin (bson_writer_t *writer, bson_t **bson);Parameterswriter A bson_writer_t \&.bson A bson_t \&.DescriptionBegins writing a new document. The caller may use the bson structure to…

bson_vsnprintf() – Like bson_snprintf() but allows for variadic parameters. Synopsisint bson_vsnprintf (char *str, size_t size, const char *format, va_list ap) BSON_GNUC_PRINTF (3, 0);Parametersstr A location for the resulting string.size The size of str in bytes.format A printf style format string.ap A va_list of parameters for the format.DescriptionLike bson_snprintf() but allows for variadic parameters. ReturnsThe number…

bson_visitor_t – The bson_visitor_t structure provides a series of callbacks that can be called while iterating a BSON document. This may simplify the conversion of a bson_t to a higher level language structure. Synopsis#include <bson.h> typedef struct { bool (*visit_before) (const bson_iter_t *iter, const char *key, void *data); bool (*visit_after) (const bson_iter_t *iter, const char…

bson_value_t – BSON Boxed Container Type Synopsis#include <bson.h> typedef struct _bson_value_t { bson_type_t value_type; union { bson_oid_t v_oid; int64_t v_int64; int32_t v_int32; int8_t v_int8; double v_double; bool v_bool; int64_t v_datetime; struct { uint32_t timestamp; uint32_t increment; } v_timestamp; struct { uint32_t len; char *str; } v_utf8; struct { uint32_t data_len; uint8_t *data; } v_doc; struct…

bson_value_destroy() – Releases any resources associated with value. Synopsisvoid bson_value_destroy (bson_value_t *value);Parametersvalue A bson_value_t \&.DescriptionReleases any resources associated with value \&. ColophonThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

bson_value_copy() – This function will copy the boxed content in src into dst. dst must be freed with bson_value_destroy() when no longer in use. Synopsisvoid bson_value_copy (const bson_value_t *src, bson_value_t *dst);Parameterssrc A bson_value_t to copy from.dst A bson_value_t to copy into.DescriptionThis function will copy the boxed content in src into dst \&. dst must be…

bson_validate() – Validates a BSON document by walking through the document and inspecting the fields for valid content. Synopsistypedef enum { BSON_VALIDATE_NONE = 0, BSON_VALIDATE_UTF8 = (1 << 0), BSON_VALIDATE_DOLLAR_KEYS = (1 << 1), BSON_VALIDATE_DOT_KEYS = (1 << 2), BSON_VALIDATE_UTF8_ALLOW_NULL = (1 << 3), } bson_validate_flags_t; bool bson_validate (const bson_t *bson, bson_validate_flags_t flags, size_t *offset);Parametersbson…

bson_utf8_validate() – Validates that the content within utf8 is valid UTF-8. If allow_null is true, then embedded NULL bytes are allowed ( ). Synopsisbool bson_utf8_validate (const char *utf8, size_t utf8_len, bool allow_null);Parametersutf8 A string to verify.utf8_len The length of utf8 in bytes.allow_null A bool indicating that embedded \0 bytes are allowed.DescriptionValidates that the content within utf8…

bson_utf8_next_char() – Advances within utf8 to the next UTF-8 character, which may be multiple bytes offset from utf8. A pointer to the next character is returned. Synopsisconst char * bson_utf8_next_char (const char *utf8);Parametersutf8 A UTF-8 encoded string.DescriptionAdvances within utf8 to the next UTF-8 character, which may be multiple bytes offset from utf8 \&. A pointer…

bson_utf8_get_char() – Converts the current character in a UTF-8 sequence to a bson_unichar_t, the 32-bit representation of the multi-byte character. Synopsisbson_unichar_t bson_utf8_get_char (const char *utf8);Parametersutf8 A UTF-8 encoded string.DescriptionConverts the current character in a UTF-8 sequence to a bson_unichar_t, the 32-bit representation of the multi-byte character. ReturnsA bson_unichar_t. ColophonThis page is part of libbson. Please…

bson_utf8_from_unichar() – Converts a single unicode character to a multi-byte UTF-8 sequence. The result is stored in utf8 and the number of bytes used in len. Synopsisvoid bson_utf8_from_unichar (bson_unichar_t unichar, char utf8[6], uint32_t *len);Parametersunichar A bson_unichar_t \&.utf8 A location for the utf8 sequence.len A location for the number of bytes in the resulting utf8 sequence.DescriptionConverts…

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….