[#BufferedFile-2constructor]
= xref:BufferedFile.adoc[BufferedFile]::BufferedFile
:relfileprefix: ../
:mrdocs:

Wrap a source file with a ring buffer of nBufSize bytes, guaranteeing nRewindIn bytes of rewind.

== Synopsis

Declared in `<streams.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
BufferedFile(
    xref:AutoFile.adoc[AutoFile]& file,
    uint64_t nBufSize,
    uint64_t nRewindIn);
----

== Parameters

[cols="1,4"]
|===
| Name| Description
| *file*
| Source file to read from.
| *nBufSize*
| Size in bytes of the ring buffer.
| *nRewindIn*
| Number of bytes guaranteed to be rewindable; must be less than nBufSize.
|===


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