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

SYNOPSIS

6          typedef ssize_t (*bson_reader_read_func_t) (void *handle,
7                                                      void *buf,
8                                                      size_t count);
9

PARAMETERS

11handle: The handle to read from.
12
13buf: The buffer to read into.
14
15count: The number of bytes to read.
16

DESCRIPTION

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

RETURNS

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

AUTHOR

32       MongoDB, Inc
33
35       2017-present, MongoDB, Inc
36
37
38
39
401.25.1                           Nov 08, 2023       BSON_READER_READ_FUNC_T(3)
Impressum