CeresEngine::IStream Class Reference

An interface that all data streams must implement. More...

#include <CeresEngine/Foundation/IO/Stream.hpp>

Inheritance diagram for CeresEngine::IStream:

Public Types
enum class	Seek { Start = SEEK_SET , Current = SEEK_CUR , End = SEEK_END }
	An enumeration that describes how a data stream should be seeked. More...

Public Member Functions
	IStream ()=default
	IStream (const IStream &) noexcept=delete
IStream &	operator= (const IStream &) noexcept=delete
	IStream (IStream &&) noexcept=default
IStream &	operator= (IStream &&) noexcept=default
virtual	~IStream () noexcept=default
virtual bool	isSeekable (Seek mode=Seek::Start) const noexcept
	Checks if the stream is seekable.
virtual void	seek (std::streamsize position, Seek mode=Seek::Start)
	Changes the position of the data stream.
void	skip (const size_t n)
	Skips n bytes from the data stream.
virtual bool	isTellable () const noexcept
	Checks if the stream knows it's current absolute position.
virtual size_t	tell ()
	Gets the absolute stream position, in bytes.
virtual bool	isSizeKnown () const noexcept
	Checks if the stream knows the size of the data.
virtual size_t	size ()
	Gets the number of bytes available on the stream.

Detailed Description

An interface that all data streams must implement.

This class’s interface is common to all stream classes, including its subclasses InputStream and OutputStream.

Stream objects provide an easy way to read and write data to and from a variety of media in a device-independent way. You can create stream objects for data located in memory, in a file, or on a network (using sockets), and you can use stream objects without loading all of the data into memory at once.

By default, Stream instances that aren’t file-based are non-seekable, one-way streams (although custom seekable subclasses are possible). After you provide or consume data, you can’t retrieve the data from the stream.

Member Enumeration Documentation

Seek

enum class CeresEngine::IStream::Seek

strong

An enumeration that describes how a data stream should be seeked.

Enumerator
Start
Current
End

Constructor & Destructor Documentation

IStream() [1/3]

CeresEngine::IStream::IStream ( )

default

IStream() [2/3]

CeresEngine::IStream::IStream ( const IStream &  )

deletenoexcept

IStream() [3/3]

CeresEngine::IStream::IStream ( IStream &&  )

defaultnoexcept

~IStream()

virtual CeresEngine::IStream::~IStream ( )

virtualdefaultnoexcept

Member Function Documentation

isSeekable()

virtual bool CeresEngine::IStream::isSeekable ( Seek  mode = Seek::Start ) const

inlinevirtualnoexcept

Checks if the stream is seekable.

If this method returns true, seek() is safe to be called on this stream.

Reimplemented in CeresEngine::AsyncDataStreamAdapter, CeresEngine::MemoryDataStream, CeresEngine::FilteredInputStream, CeresEngine::FilteredOutputStream, CeresEngine::FilteredDataStream, CeresEngine::WrappedResourceInputStream, CeresEngine::WrappedResourceOutputStream, CeresEngine::FileDataStream, CeresEngine::PipeStream, CeresEngine::PipeInputStream, CeresEngine::PipeOutputStream, and CeresEngine::LimitedInputStream.

isSizeKnown()

virtual bool CeresEngine::IStream::isSizeKnown ( ) const

virtualnoexcept

Checks if the stream knows the size of the data.

If this method returns true, size() is safe to be called on this stream.

Reimplemented in CeresEngine::AsyncDataStreamAdapter, CeresEngine::FileDataStream, CeresEngine::MemoryDataStream, CeresEngine::PipeStream, CeresEngine::PipeInputStream, CeresEngine::PipeOutputStream, CeresEngine::FilteredInputStream, CeresEngine::FilteredOutputStream, CeresEngine::FilteredDataStream, CeresEngine::LimitedInputStream, CeresEngine::WrappedResourceInputStream, and CeresEngine::WrappedResourceOutputStream.

isTellable()

virtual bool CeresEngine::IStream::isTellable ( ) const

inlinevirtualnoexcept

Checks if the stream knows it's current absolute position.

If this method returns true, tell() is safe to be called on this stream.

Reimplemented in CeresEngine::BufferedDataStream, CeresEngine::AsyncDataStreamAdapter, CeresEngine::FileDataStream, CeresEngine::MemoryDataStream, CeresEngine::PipeStream, CeresEngine::PipeInputStream, CeresEngine::PipeOutputStream, CeresEngine::FilteredInputStream, CeresEngine::FilteredOutputStream, CeresEngine::FilteredDataStream, CeresEngine::LimitedInputStream, CeresEngine::WrappedResourceInputStream, and CeresEngine::WrappedResourceOutputStream.

operator=() [1/2]

IStream & CeresEngine::IStream::operator= ( const IStream &  )

deletenoexcept

operator=() [2/2]

IStream & CeresEngine::IStream::operator= ( IStream &&  )

defaultnoexcept

seek()

virtual void CeresEngine::IStream::seek ( std::streamsize  position, Seek  mode = Seek::Start  )

virtual

Changes the position of the data stream.

Note

This method is only callable if isSeekable() returns true.

Parameters

position	The position to set the data stream to.
mode	The mode to change the data stream position.

Reimplemented in CeresEngine::FilteredInputStream, CeresEngine::FilteredOutputStream, CeresEngine::FilteredDataStream, CeresEngine::WrappedResourceInputStream, CeresEngine::WrappedResourceOutputStream, CeresEngine::BufferedInputStream, CeresEngine::BufferedOutputStream, CeresEngine::BufferedDataStream, CeresEngine::AsyncDataStreamAdapter, CeresEngine::FileDataStream, CeresEngine::MemoryDataStream, and CeresEngine::LimitedInputStream.

size()

virtual size_t CeresEngine::IStream::size ( )

virtual

Gets the number of bytes available on the stream.

Note

This method is only callable if isSizeKnown() returns true.

Reimplemented in CeresEngine::AsyncDataStreamAdapter, CeresEngine::FileDataStream, CeresEngine::MemoryDataStream, CeresEngine::FilteredInputStream, CeresEngine::FilteredOutputStream, CeresEngine::FilteredDataStream, CeresEngine::LimitedInputStream, CeresEngine::WrappedResourceInputStream, and CeresEngine::WrappedResourceOutputStream.

skip()

void CeresEngine::IStream::skip ( const size_t  n )

inline

Skips n bytes from the data stream.

tell()

virtual size_t CeresEngine::IStream::tell ( )

virtual

Gets the absolute stream position, in bytes.

Note

This method is only callable if isTellable() returns true.

Reimplemented in CeresEngine::BufferedInputStream, CeresEngine::BufferedOutputStream, CeresEngine::BufferedDataStream, CeresEngine::AsyncDataStreamAdapter, CeresEngine::FileDataStream, CeresEngine::MemoryDataStream, CeresEngine::FilteredInputStream, CeresEngine::FilteredOutputStream, CeresEngine::FilteredDataStream, CeresEngine::LimitedInputStream, CeresEngine::WrappedResourceInputStream, and CeresEngine::WrappedResourceOutputStream.

---

The documentation for this class was generated from the following file:

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Foundation/IO/Stream.hpp