.. _utilities_fileio_reader:

============
StreamReader
============

The StreamReader class is the utilitiy for reading data from a Rogue file in a streaming fashion.

The file format consumed by StreamReader is documented here:

- :ref:`utilities_fileio_format`


StreamReader objects in C++ are referenced by the following shared pointer typedef:

.. doxygentypedef:: rogue::utilities::fileio::StreamReaderPtr

The class description is shown below:

.. doxygenclass:: rogue::utilities::fileio::StreamReader
   :members: