Class BinaryFileStream

Source/Falcor/Utils/BinaryFileStream.h:37–188

* Helper class to manage file I/O with binary files */

 * Helper class to manage file I/O with binary files
 */
class BinaryFileStream
{
public:
    /**
     * Mode to open file as
     */
    enum class Mode
    {
        Read = 0x1,     ///< Open file for reading
        Write = 0x2,    ///< Open file for writing
        ReadWrite = 0x3 ///< Open file for both reading and writing
    };

    /**
     * Default constructor.
     */
    BinaryFileStream(){};

    /**
     * Constructor that opens a file
     * @param[in] path Path of file to open or create
     * @param[in] mode Mode to open file as
     */
    BinaryFileStream(const std::filesystem::path& path, Mode mode = Mode::ReadWrite) { open(path, mode); }

    /**
     * Destructor
     */
    ~BinaryFileStream() { close(); }

    /**
     * Opens a file stream. Fails if a file is already open.
     * @param[in] path Path of file to open or create
     * @param[in] mode Mode to open file as
     */
    void open(const std::filesystem::path& path, Mode mode = Mode::ReadWrite)
    {
        std::ios::openmode iosMode = std::ios::binary;
        iosMode |= ((mode == Mode::Read) || (mode == Mode::ReadWrite)) ? std::ios::in : (std::ios::openmode)0;
        iosMode |= ((mode == Mode::Write) || (mode == Mode::ReadWrite)) ? std::ios::out : (std::ios::openmode)0;
        mStream.open(path, iosMode);
        mPath = path;
    }

    /**
     * Close the file stream.
     */
    void close() { mStream.close(); }

    /**
     * Skip data in an input stream. Advances file stream without reading.
     * @param[in] count Bytes to skip
     */
    void skip(uint32_t count) { mStream.ignore(count); }

    /**
     * Deletes the managed file.
     */