Resource::PFRecordRead class

#include <Spore ModAPI/Spore/Resource/PFRecordRead.h>

void Resource::PFRecordRead::SetKey(const ResourceKey& key) override

Sets the ResourceKey name that identifies this record.

IStream* Resource::PFRecordRead::GetStream() override

Returns the IStream used to access this record data.

uint32_t Resource::PFRecordRead::GetType() const override

Returns the type of the stream, which is different for each Stream subclass.

This function can be used for run-time type identification. A type of zero means the type is unknown or invalid.

IO::AccessFlags Resource::PFRecordRead::GetAccessFlags() const override

Returns one of enum AccessFlags.

This function also tells you if the stream is open, as a return value of zero means the stream is not open. It is not allowed that a stream
be open with no type of access.

IO::FileError Resource::PFRecordRead::GetState() const override

Returns the error state of the stream.

Returns FileError::Success if OK, else an error code. This function is similar to 'errno' or a 'get last error' facility.

IO::size_type Resource::PFRecordRead::GetSize() const override

Returns the size of the stream, which is not the same as the size of bytes remaining to be read from the stream.

Returns (size_type)-2 if the stream is of indeterminate size. Returns (size_type)-1 (a.k.a. kSizeTypeError) upon error.

bool Resource::PFRecordRead::SetSize(IO::size_type size) override

Sets the size of the stream, if possible.

It is debatable whether this function should be present in IStream or only in suclasses of StreamBase which are writable. For consistency with GetSize, we put the function here. But also consider that a SetSize function is not necessarily a data writing function, depending on the stream implementation.

int Resource::PFRecordRead::GetPosition(IO::PositionType positionType = IO::PositionType::Begin) const override

Gets the current read/write position within the stream.

The read and write positions of a stream must be the same value; you cannot have a read position that is different from a write position. However, a Stream subclass can provide such functionality if needed. Returns -1 upon error.

bool Resource::PFRecordRead::SetPosition(int distance, IO::PositionType positionType = IO::PositionType::Begin) override

Sets the read/write position of the stream.

If the specified position is beyond the size of a fixed stream, the position is set to the end of the stream. A writable stream subclass may provide a policy whereby setting the position beyond the end of the stream results in an increase in the stream size.

int Resource::PFRecordRead::GetAvailable() const override

Returns the number of bytes available for reading.

Returns (size_type)-1 (a.k.a. kSizeTypeError) upon error. This function is non-blocking; it should return immediately.

int Resource::PFRecordRead::Read(void* pData, size_t nSize) override

Reads bytes from the stream given by the input count 'nSize'.

If less then nSize bytes are available, then those bytes will be read. Returns the number of bytes read. A return value of zero means that there were no bytes to be read or no bytes were requested to be read. A return value of zero means the end of file was reached. A return value > 0 but < 'nSize' is possible, and it does not necessarily mean that the end of the file was reached. Returns (size_type)-1 (a.k.a. kSizeTypeError) if there was an error. You can use this return value or IStream::GetState to determine the error. Input size values equal to (size_type)-1 (a.k.a. kSizeTypeError) are not valid input. Upon error, the stream pointer is at the position it was upon the error occurrence.

bool Resource::PFRecordRead::Flush() override

Flush any non-empty stream write buffers.

If the return value is false, GetState will give the error code. This function implements the flushing as per the underlying file system. The behavior of the Flush function varies with the underlying platform.

A common use of Flush is write a file to disk immediately in order to prevent the file from being corrupted if the application crashes before the file is closed. However, on desktop platforms such as Windows this strategy is unnecesary, as the Windows OS file flush doesn't write the file to disk as might be expected. This actually is not a problem, because the Windows OS manages files outside the process and if your process crashes the OS will take care of safely closing the files. Only if the machine power is lost or if certain kinds of kernel-level crashes occur may you lose file data.

int Resource::PFRecordRead::Write(const void* pData, size_t nSize) override

Writes bytes to the stream.

If false is returned, you can use IStream::GetState to determine the error. Upon error, the stream pointer is at the position it was upon the error occurrence.