Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
BSON_READER_READ(3)		    libbson		   BSON_READER_READ(3)

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

AUTHOR
       MongoDB,	Inc

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 2025		   BSON_READER_READ(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=bson_reader_read&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help