bionic (3) bson_reader_read_func_t.3.gz

Provided by: libbson-doc_1.9.2-1_all bug

NAME
       bson_reader_read_func_t - bson_reader_read_func_t


SYNOPSIS
          typedef ssize_t (*bson_reader_read_func_t) (void *handle,
                                                      void *buf,
                                                      size_t count);


PARAMETERS
       • handle: The handle to read from.

       • buf: The buffer to read into.

       • count: The number of bytes to read.


DESCRIPTION
       A  callback  function  that  will  be  called  by  bson_reader_t  to read the next chunk of data from the
       underlying opaque file descriptor.

       This function is meant to operate similar to the read(2) function as part of libc on UNIX-like systems.


RETURNS
       0 for end of stream.

       -1 for a failure on read.

       A value greater than zero for the number of bytes read into buf.


AUTHOR
       MongoDB, Inc


       2018, MongoDB, Inc