1
0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-04 09:42:40 +02:00
vcmi/lib/filesystem/CMemoryStream.h
2015-12-05 12:06:33 +03:00

79 lines
1.7 KiB
C++

#pragma once
/*
* CMemoryStream.h, part of VCMI engine
*
* Authors: listed in file AUTHORS in main folder
*
* License: GNU General Public License v2.0 or later
* Full text of license available in license.txt file, in main folder
*
*/
#include "CInputStream.h"
/**
* A class which provides method definitions for reading from memory.
* @deprecated use CMemoryBuffer
*/
class DLL_LINKAGE CMemoryStream : public CInputStream
{
public:
/**
* C-tor. The data buffer won't be free'd. (no ownership)
*
* @param data a pointer to the data array.
* @param size The size in bytes of the array.
*/
CMemoryStream(const ui8 * data, si64 size);
/**
* Reads n bytes from the stream into the data buffer.
*
* @param data A pointer to the destination data array.
* @param size The number of bytes to read.
* @return the number of bytes read actually.
*/
si64 read(ui8 * data, si64 size) override;
/**
* Seeks the internal read pointer to the specified position.
*
* @param position The read position from the beginning.
* @return the position actually moved to, -1 on error.
*/
si64 seek(si64 position) override;
/**
* Gets the current read position in the stream.
*
* @return the read position.
*/
si64 tell() override;
/**
* Skips delta numbers of bytes.
*
* @param delta The count of bytes to skip.
* @return the count of bytes skipped actually.
*/
si64 skip(si64 delta) override;
/**
* Gets the length in bytes of the stream.
*
* @return the length in bytes of the stream.
*/
si64 getSize() override;
private:
/** A pointer to the data array. */
const ui8 * data;
/** The size in bytes of the array. */
si64 size;
/** Current reading position of the stream. */
si64 position;
};