.\" Man page generated from reStructuredText.
.
.TH "BSON_READER_READ_FUNC_T" "3" "Feb 23, 2019" "1.14.0" "Libbson"
.SH NAME
bson_reader_read_func_t \- bson_reader_read_func_t
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
typedef ssize_t (*bson_reader_read_func_t) (void *handle,
                                            void *buf,
                                            size_t count);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBhandle\fP: The handle to read from.
.IP \(bu 2
\fBbuf\fP: The buffer to read into.
.IP \(bu 2
\fBcount\fP: The number of bytes to read.
.UNINDENT
.SH DESCRIPTION
.sp
A callback function that will be called by \fBbson_reader_t\fP to read the next chunk of data from the underlying opaque file descriptor.
.sp
This function is meant to operate similar to the \fBread(2)\fP function as part of libc on UNIX\-like systems.
.SH RETURNS
.sp
0 for end of stream.
.sp
\-1 for a failure on read.
.sp
A value greater than zero for the number of bytes read into \fBbuf\fP\&.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.