bson_reader_read (3) - Linux Manuals

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

NAME

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

SYNOPSIS

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

PARAMETERS

reader
A bson_reader_t \&.

reached_eof
A UNKNOWN.

DESCRIPTION

The bson_reader_read(3) 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.

EXAMPLE

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");
}

COLOPHON

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

Pages related to bson_reader_read

  • bson_reader_read_func_t (3) - A callback function that will be called by bson_reader_t to read the next chunk of data from the underlying opaque file descriptor.
  • bson_reader_destroy (3) - Destroys and releases all resources associated with reader.
  • bson_reader_destroy_func_t (3) - An optional callback function that will be called when a bson_reader_t created with bson_reader_new_from_handle is destroyed with bson_reader_destroy().
  • bson_reader_new_from_data (3) - The bson_reader_new_from_data() function shall create a new bson_reader_t using the buffer supplied. data is not copied and MUST be valid for the lifetime of the resulting bson_reader_t.
  • bson_reader_new_from_fd (3) - The bson_reader_new_from_fd() function shall create a new bson_reader_t that will read from the provided file-descriptor.
  • bson_reader_new_from_file (3) - Creates a new bson_reader_t using the file denoted by filename.
  • bson_reader_new_from_handle (3) - This function allows for a pluggable data stream for the reader. This can be used to read from sockets, files, memory, or other arbitrary sources.
  • bson_reader_set_destroy_func (3) - Allows for setting a callback to be executed when a reader is destroyed. This should only be used by implementations implementing their own read callbacks.
  • bson_reader_set_read_func (3) - Sets the function to read more data from the underlying stream in a custom bson_reader_t.
  • bson_reader_t (3) - Streaming BSON Document Reader
  • bson_reader_tell (3) - Tells the current position within the underlying stream.
  • bson_realloc (3) - This is a portable realloc() wrapper.