CeresEngine::FilteredDataStream Class Reference

A helper data stream that allows filtering the results of another data stream. More...

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

Inheritance diagram for CeresEngine::FilteredDataStream:

Public Member Functions
	FilteredDataStream (DataStream &&dataStream)
	Creates a new filtered data stream.
	FilteredDataStream (FilteredDataStream &&) noexcept=default
	~FilteredDataStream () override=default
DataStream &	getDataStream () noexcept
	The data stream being filtered.
const DataStream &	getDataStream () const noexcept
	The data stream being filtered.
bool	isSeekable (const Seek mode=Seek::Start) const noexcept override
	Checks if the stream is seekable.
void	seek (const std::streamsize position, const Seek mode=Seek::Start) override
	Changes the position of the data stream.
bool	isTellable () const noexcept override
	Checks if the stream knows it's current absolute position.
size_t	tell () override
	Gets the absolute stream position, in bytes.
bool	isSizeKnown () const noexcept override
	Checks if the stream knows the size of the data.
size_t	size () override
	Gets the number of bytes available on the stream.
bool	isReadable () const noexcept override
	Checks if the stream is readable.
size_t	read (void *data, const size_t n) override
	Reads data from the data stream to a buffer of raw memory data with length n.
bool	invalidate () override
	In the stream is buffered, invalidates any buffered read data from the stream.
bool	isWritable () const noexcept override
	Checks if the stream is writable.
size_t	write (const void *data, const size_t n) override
	Writes data to the data stream from a buffer of raw memory data with length n.
bool	flush () override
	In the stream is buffered, invalidates any buffered write data from to stream.
Public Member Functions inherited from CeresEngine::IInputStream
template<typename T >
size_t	read (const MemoryView< T > &memoryView)
	Reads data from the strea into a memory view.
template<typename T >
size_t	read (const StridedMemoryView< T > &memoryView)
	Reads data from the stream into a strided memory view.
Optional< String >	readString ()
	Reads data from the buffer as a C++ String.
template<typename T > requires std::is_trivially_copyable_v<T>
Optional< T >	read ()
	Reads a trivially copyable obhect from the stream.
Public Member Functions inherited from CeresEngine::IStream
	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
void	skip (const size_t n)
	Skips n bytes from the data stream.
Public Member Functions inherited from CeresEngine::IOutputStream
template<typename T >
size_t	write (const MemoryView< const T > &memoryView)
	Writes data from a memory view to the stream.
template<typename T >
size_t	write (const StridedMemoryView< const T > &memoryView)
	Writes data from a strided memory view to the stream.
size_t	writeString (const StringView string)
	Writes a string to the data stream.
template<typename T > requires std::is_trivially_copyable_v<T>
bool	write (T value)
	Writes a trivially copyable object to the stream.

Protected Attributes
DataStream	mDataStream
	The data stream being filtered.

Additional Inherited Members
Public Types inherited from CeresEngine::IStream
enum class	Seek { Start = SEEK_SET , Current = SEEK_CUR , End = SEEK_END }
	An enumeration that describes how a data stream should be seeked. More...

Detailed Description

A helper data stream that allows filtering the results of another data stream.

Constructor & Destructor Documentation

FilteredDataStream() [1/2]

CeresEngine::FilteredDataStream::FilteredDataStream ( DataStream &&  dataStream )

inlineexplicit

Creates a new filtered data stream.

FilteredDataStream() [2/2]

CeresEngine::FilteredDataStream::FilteredDataStream ( FilteredDataStream &&  )

defaultnoexcept

~FilteredDataStream()

CeresEngine::FilteredDataStream::~FilteredDataStream ( )

overridedefault

Member Function Documentation

flush()

bool CeresEngine::FilteredDataStream::flush ( )

inlineoverridevirtual

In the stream is buffered, invalidates any buffered write data from to stream.

Non-buffered streams are free to ignore this method.

Returns

True if the flushing finished successfully; false otherwise.

Reimplemented from CeresEngine::IOutputStream.

getDataStream() [1/2]

const DataStream & CeresEngine::FilteredDataStream::getDataStream ( ) const

inlinenoexcept

The data stream being filtered.

getDataStream() [2/2]

DataStream & CeresEngine::FilteredDataStream::getDataStream ( )

inlinenoexcept

The data stream being filtered.

invalidate()

bool CeresEngine::FilteredDataStream::invalidate ( )

inlineoverridevirtual

In the stream is buffered, invalidates any buffered read data from the stream.

Non-buffered streams are free to ignore this method.

Returns

True if the invalidation finished successfully; false otherwise.

Reimplemented from CeresEngine::IInputStream.

isReadable()

bool CeresEngine::FilteredDataStream::isReadable ( ) const

inlineoverridevirtualnoexcept

Checks if the stream is readable.

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

Reimplemented from CeresEngine::IInputStream.

isSeekable()

bool CeresEngine::FilteredDataStream::isSeekable ( const Seek  mode = Seek::Start ) const

inlineoverridevirtualnoexcept

Checks if the stream is seekable.

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

Reimplemented from CeresEngine::IStream.

isSizeKnown()

bool CeresEngine::FilteredDataStream::isSizeKnown ( ) const

inlineoverridevirtualnoexcept

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 from CeresEngine::IStream.

isTellable()

bool CeresEngine::FilteredDataStream::isTellable ( ) const

inlineoverridevirtualnoexcept

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 from CeresEngine::IStream.

isWritable()

bool CeresEngine::FilteredDataStream::isWritable ( ) const

inlineoverridevirtualnoexcept

Checks if the stream is writable.

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

Reimplemented from CeresEngine::IOutputStream.

read()

size_t CeresEngine::FilteredDataStream::read ( void *  data, const size_t  n  )

inlineoverridevirtual

Reads data from the data stream to a buffer of raw memory data with length n.

Note

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

Parameters

data	The memory location to which read data should be placed.
n	The maximum number of bytes to be read from the data stream.

Returns

The number of bytes actually read. Can be smaller than n. If 0, indicates that the stream has ended.

Reimplemented from CeresEngine::IInputStream.

seek()

void CeresEngine::FilteredDataStream::seek ( const std::streamsize  position, const Seek  mode = Seek::Start  )

inlineoverridevirtual

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 from CeresEngine::IStream.

size()

size_t CeresEngine::FilteredDataStream::size ( )

inlineoverridevirtual

Gets the number of bytes available on the stream.

Note

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

Reimplemented from CeresEngine::IStream.

tell()

size_t CeresEngine::FilteredDataStream::tell ( )

inlineoverridevirtual

Gets the absolute stream position, in bytes.

Note

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

Reimplemented from CeresEngine::IStream.

write()

size_t CeresEngine::FilteredDataStream::write ( const void *  data, const size_t  n  )

inlineoverridevirtual

Writes data to the data stream from a buffer of raw memory data with length n.

Note

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

Parameters

data	The memory location to which written data should be copied from.
n	The maximum number of bytes to be write to the data stream.

Returns

The number of bytes actually written. Can be smaller than n, in that case the write operation must be repeated to ensure that all data was written. If 0, indicates that the stream has ended.

Reimplemented from CeresEngine::IOutputStream.

Member Data Documentation

mDataStream

DataStream CeresEngine::FilteredDataStream::mDataStream

protected

The data stream being filtered.

---

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

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