bson_error_t (3) - Linux Manuals

bson_error_t: BSON Error Encapsulation

NAME

bson_error_t - BSON Error Encapsulation

SYNOPSIS

#include <bson.h>

typedef struct
{
   uint32_t domain;
   uint32_t code;
   char     message[504];
} bson_error_t;

DESCRIPTION

The bson_error_t structure is used to encapsulate information about an error. Think of it as the information stored in an exception without stack trace information. It includes information about the module and error code of the error along with a human printable message.

The error.domain field contains the logical domain within a library that created the error. This might be the JSON subsystem or bson_reader_t for example.

The error.code field contains the domain specific error code.

The error.message field contains a human printable error message.

EXAMPLE

bson_reader_t *reader;
bson_error_t error;

reader = bson_reader_new_from_file ("dump.bson", &error);
if (!reader) {
   fprintf (stderr, "ERROR: %d.%d: %s\n",
            error.domain, error.code, error.message);
}

COLOPHON

This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Pages related to bson_error_t

  • bson_equal (3) - The bson_equal() function shall return true if both documents are equal.
  • bson_append_array (3) - The bson_append_array() function shall append child to bson using the specified key. The type of the field will be an array, but it is the responsibility of the caller to ensure that the keys of child are properly formatted with string keys such as &quot;0&quot;, &quot;1&quot;, &quot;2&quot; and so forth.
  • bson_append_array_begin (3) - The bson_append_array_begin() function shall begin appending an array field to bson. This allows for incrementally building a sub-array. Doing so will generally yield better performance as you will serialize to a single buffer. When done building the sub-array, the caller MUST call bson_append_array_end().
  • bson_append_array_end (3) - The bson_append_array_end() function shall complete the appending of an array field started with bson_append_array_begin(). child is invalid after calling this function.
  • bson_append_binary (3) - The bson_append_binary() function shall append a new element to bson containing the binary data provided.
  • bson_append_bool (3) - The bson_append_bool() function shall append a new element to bson containing the boolean provided.
  • bson_append_code (3) - The bson_append_code() function shall append a new element to bson using the UTF-8 encoded javascript provided. javascript must be a NULL terminated C string.
  • bson_append_code_with_scope (3) - The bson_append_code_with_scope() function shall perform like bson_append_code() except it allows providing a scope to the javascript function in the form of a bson document.
  • bson_append_date_time (3) - The bson_append_date_time() function shall append a new element to a bson document containing a date and time with no timezone information. value is assumed to be in UTC format of milliseconds since the UNIX epoch. value MAY be negative.