1BSON_READER_READ_FUNC_T(3)          libbson         BSON_READER_READ_FUNC_T(3)
2
3
4

NAME

6       bson_reader_read_func_t - bson_reader_read_func_t
7

SYNOPSIS

9          typedef ssize_t (*bson_reader_read_func_t) (void *handle,
10                                                      void *buf,
11                                                      size_t count);
12

PARAMETERS

14handle: The handle to read from.
15
16buf: The buffer to read into.
17
18count: The number of bytes to read.
19

DESCRIPTION

21       A  callback  function  that will be called by bson_reader_t to read the
22       next chunk of data from the underlying opaque file descriptor.
23
24       This function is meant to operate similar to the  read(2)  function  as
25       part of libc on UNIX-like systems.
26

RETURNS

28       0 for end of stream.
29
30       -1 for a failure on read.
31
32       A value greater than zero for the number of bytes read into buf.
33

AUTHOR

35       MongoDB, Inc
36
38       2017-present, MongoDB, Inc
39
40
41
42
431.23.1                           Oct 20, 2022       BSON_READER_READ_FUNC_T(3)
Impressum