bson_reader_read(3)

bson_reader_read3

Usage

const bson_t *
bson_reader_read (bson_reader_t *reader, bool *reached_eof);

Parameters

•

reader: A bson_reader_t.

•

reached_eof: A UNKNOWN.

Overview

The bson_reader_read() function shall read the next document from the underlying file-descriptor or buffer.

If there are no further documents or a failure was detected, then NULL is returned.

If we reached the end of the sequence, reached_eof is set to true.

To detect an error, check for NULL and reached_of is false.

Returns

A bson_t that should not be modified or freed.

Examples

const bson_t *doc;
bool reached_eof = false;
while ((doc = bson_reader_read (reader, &reached_eof))) {
   /* do something */
}
if (!reached_eof) {
   fprintf (stderr, "Failed to read all documents.\n");
}

Releases

5 releases since Debian 9 (Stretch); the text changed 4 times.

  1. 9
  2. 10
  3. 11
  4. 12
  5. 13

Author

MongoDB, Inc

From libbson-doc 1.30.4-1+deb13u3 in Debian 13 (Trixie). Parsed by carta from the page's man source.