bson_iter_type (3) - Linux Manuals

bson_iter_type: The bson_iter_type() function shall return the type of the observed element in a bson document.

NAME

bson_iter_type() - The bson_iter_type() function shall return the type of the observed element in a bson document.

SYNOPSIS

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_TYPE_CODEWSCOPE    = 0x0F,
   BSON_TYPE_INT32         = 0x10,
   BSON_TYPE_TIMESTAMP     = 0x11,
   BSON_TYPE_INT64         = 0x12,
   BSON_TYPE_MAXKEY        = 0x7F,
   BSON_TYPE_MINKEY        = 0xFF,
} bson_type_t;

bson_type_t
bson_iter_type (const bson_iter_t *iter);

PARAMETERS

iter
A bson_iter_t \&.

DESCRIPTION

The bson_iter_type(3) function shall return the type of the observed element in a bson document.

RETURNS

A bson_type_t \&.

COLOPHON

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

Pages related to bson_iter_type

  • bson_iter_t (3) - BSON Document Iterator
  • bson_iter_time_t (3) - The bson_iter_time_t() function shall return the number of seconds since the UNIX epoch, as contained in the BSON_TYPE_DATE_TIME element.
  • bson_iter_timestamp (3) - The BSON_TYPE_TIMESTAMP type is not a date/time and is typically used for intra-server communication.
  • bson_iter_timeval (3) - The bson_iter_timeval() function shall return the number of seconds and microseconds since the UNIX epoch, as contained in the BSON_TYPE_DATE_TIME element into tv.
  • bson_iter_array (3) - The bson_iter_array() function shall retrieve the raw buffer of a sub-array from iter. iter MUST be on an element that is of type BSON_TYPE_ARRAY. This can be verified with bson_iter_type() or the BSON_ITER_HOLDS_ARRAY() macro.
  • bson_iter_as_bool (3) - Fetches the current field as if it were a boolean.
  • bson_iter_as_int64 (3) - The bson_iter_as_int64() function shall return the contents of the current element as if it were a BSON_TYPE_INT64 element. The currently supported casts include:
  • bson_iter_binary (3) - This function shall return the binary data of a BSON_TYPE_BINARY element. It is a programming error to call this function on a field that is not of type BSON_TYPE_BINARY. You can check this with the BSON_ITER_HOLDS_BINARY() macro or bson_iter_type().
  • bson_iter_bool (3) - The bson_iter_bool()function shall return the boolean value of a BSON_TYPE_BOOL element. It is a programming error to call this function on an element other than BSON_TYPE_BOOL. You can check this with bson_iter_type() or BSON_ITER_HOLDS_BOOL().
  • bson_iter_code (3) - This function returns the contents of a BSON_TYPE_CODE field. The length of the string is stored in length if non-NULL.
  • bson_iter_codewscope (3) - The bson_iter_codewscope() function acts similar to bson_iter_code() except for BSON_TYPE_CODEWSCOPE elements. It also will provide a pointer to the buffer for scope, which can be loaded into a bson_t using bson_init_static().
  • bson_iter_date_time (3) - The bson_iter_date_time() function shall return the number of miliseconds since the UNIX epoch, as contained in the BSON_TYPE_DATE_TIME element.
  • bson_iter_dbpointer (3) - Fetches the contents of a BSON_TYPE_DBPOINTER element.
  • bson_iter_document (3) - The bson_iter_document() function shall retrieve the raw buffer of a sub-document from iter. iter MUST be on an element that is of type BSON_TYPE_DOCUMENT. This can be verified with bson_iter_type() or the BSON_ITER_HOLDS_DOCUMENT() macro.