.\" Man page generated from reStructuredText.
.
.TH "BSON_READER_NEW_FROM_FD" "3" "Jun 04, 2021" "1.17.6" "libbson"
.SH NAME
bson_reader_new_from_fd \- bson_reader_new_from_fd()
.
.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
bson_reader_t *
bson_reader_new_from_fd (int fd, bool close_on_destroy);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBfd\fP: A valid file\-descriptor.
.IP \(bu 2
\fBclose_on_destroy\fP: Whether \fBclose()\fP should be called on \fBfd\fP when the reader is destroyed.
.UNINDENT
.SH DESCRIPTION
.sp
The \fBbson_reader_new_from_fd()\fP function shall create a new \fBbson_reader_t\fP that will read from the provided file\-descriptor.
.sp
fd \fIMUST\fP be in blocking mode.
.sp
If \fBclose_fd\fP is true, then \fBfd\fP will be closed when the \fBbson_reader_t\fP is destroyed with \fBbson_reader_destroy()\fP\&.
.SH RETURNS
.sp
A newly allocated \fBbson_reader_t\fP that should be freed with \fBbson_reader_destroy\fP\&.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.