IO::IStream class

Derived classes

class FileStream
class FixedMemoryStream
Implements an memory-based stream that supports the IStream interface.
class MemoryStream
Implements an memory-based stream that supports the IStream interface.
class StreamBuffer
Implements a smart buffer around a random-access stream.
class StreamChild
Implements a fixed-size read-only stream which is a 'child' of a parent stream.
class StreamNull
Implements a 'bit bucket' stream, whereby all writes to the stream succeed but do nothing and all reads from the stream succeed but write nothing to the user-supplied buffer.

Constructors, destructors, conversion operators

~IStream() virtual

Public functions

auto AddRef() -> int pure virtual
auto Release() -> int pure virtual
auto GetType() const -> uint32_t pure virtual
Returns the type of the stream, which is different for each Stream subclass.
auto GetAccessFlags() const -> int pure virtual
Returns one of enum AccessFlags.
auto GetState() const -> FileError pure virtual
Returns the error state of the stream.
auto Close() -> bool pure virtual
Closes the stream and releases resouces associated with it.
auto GetSize() const -> size_type pure virtual
Returns the size of the stream, which is not the same as the size of bytes remaining to be read from the stream.
auto SetSize(size_type size) -> bool pure virtual
Sets the size of the stream, if possible.
auto GetPosition(PositionType positionType = kPositionTypeBegin) const -> int pure virtual
Gets the current read/write position within the stream.
auto SetPosition(int distance, PositionType positionType = kPositionTypeBegin) -> bool pure virtual
Sets the read/write position of the stream.
auto GetAvailable() const -> int pure virtual
Returns the number of bytes available for reading.
auto Read(void* pData, size_t nSize) -> int pure virtual
Reads bytes from the stream given by the input count 'nSize'.
auto Flush() -> bool pure virtual
Flush any non-empty stream write buffers.
auto Write(const void* pData, size_t nSize) -> int pure virtual
Writes bytes to the stream.

Function documentation

uint32_t IO::IStream::GetType() const pure virtual

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.

int IO::IStream::GetAccessFlags() const pure virtual

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.

FileError IO::IStream::GetState() const pure virtual

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.

bool IO::IStream::Close() pure virtual

Closes the stream and releases resouces associated with it.

Returns true upon success, else false. If the return value is false, GetState will give the error code. If an IStream encounters an error during operations on an open stream, it is guaranteed that you can safely call the Close function on the stream.

size_type IO::IStream::GetSize() const pure virtual

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 IO::IStream::SetSize(size_type size) pure virtual

Sets the size of the stream, if possible.

Parameters
size

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 IO::IStream::GetPosition(PositionType positionType = kPositionTypeBegin) const pure virtual

Gets the current read/write position within the stream.

Parameters
positionType

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 IO::IStream::SetPosition(int distance, PositionType positionType = kPositionTypeBegin) pure virtual

Sets the read/write position of the stream.

Parameters
distance
positionType

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 IO::IStream::GetAvailable() const pure virtual

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 IO::IStream::Read(void* pData, size_t nSize) pure virtual

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

Parameters
pData
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 IO::IStream::Flush() pure virtual

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 IO::IStream::Write(const void* pData, size_t nSize) pure virtual

Writes bytes to the stream.

Parameters
pData
nSize

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.