[#BufferedReader]
= BufferedReader
:mrdocs:

Wrapper that buffers reads from an underlying stream. Requires underlying stream to support read() and detail_fread() calls to support fixed‐size and variable‐sized reads, respectively.

== Synopsis

Declared in `<streams.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<typename S>
class BufferedReader;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BufferedReader/2constructor.adoc[`BufferedReader`]         [.small]#[constructor]#
| Requires stream ownership to prevent leaving the stream at an unexpected position after buffered reads.
| xref:BufferedReader/operator_rshift.adoc[`operator>>`] 
| Deserialize an object from the buffered reader and return this reader.
| xref:BufferedReader/read.adoc[`read`] 
| Read bytes into `dst`, serving them from the buffer and refilling from the source as needed.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#