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::FilteredOutputStream:

Public Member Functions
	FilteredOutputStream (OutputStream &&outputStream)
	Creates a new filtered data stream.

	FilteredOutputStream (FilteredOutputStream &&) noexcept=default

	~FilteredOutputStream () override=default

OutputStream &	getOutputStream () noexcept
	The data stream being filtered.

const OutputStream &	getOutputStream () 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	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.

virtual size_t	write (const void *data, size_t n)
	Writes data to the data stream from a buffer of raw memory `data` with length `n`.

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.

template<typename T > requires std::is_trivially_copyable_v<T>
bool	write (T value)
	Writes a trivially copyable object to the 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.

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.

Protected Attributes
OutputStream	mOutputStream
	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

◆ FilteredOutputStream() [1/2]

CeresEngine::FilteredOutputStream::FilteredOutputStream ( OutputStream && outputStream )

inlineexplicit

Creates a new filtered data stream.

◆ FilteredOutputStream() [2/2]

CeresEngine::FilteredOutputStream::FilteredOutputStream ( FilteredOutputStream && )

defaultnoexcept

◆ ~FilteredOutputStream()

CeresEngine::FilteredOutputStream::~FilteredOutputStream ( )

overridedefault

Member Function Documentation

◆ flush()

bool CeresEngine::FilteredOutputStream::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.

◆ getOutputStream() [1/2]

const OutputStream & CeresEngine::FilteredOutputStream::getOutputStream ( ) const

inlinenoexcept

The data stream being filtered.

◆ getOutputStream() [2/2]

OutputStream & CeresEngine::FilteredOutputStream::getOutputStream ( )

inlinenoexcept

The data stream being filtered.

◆ isSeekable()

bool CeresEngine::FilteredOutputStream::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::FilteredOutputStream::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::FilteredOutputStream::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::FilteredOutputStream::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.

◆ seek()

void CeresEngine::FilteredOutputStream::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::FilteredOutputStream::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::FilteredOutputStream::tell ( )

inlineoverridevirtual

Gets the absolute stream position, in bytes.

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

Reimplemented from CeresEngine::IStream.

◆ write() [1/5]

template<typename T >

size_t CeresEngine::IOutputStream::write ( const MemoryView< const T > & memoryView )

inline

Writes data from a memory view to the stream.

Parameters

memoryView The memory view to read data to.

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

◆ write() [2/5]

template<typename T >

size_t CeresEngine::IOutputStream::write ( const StridedMemoryView< const T > & memoryView )

inline

Writes data from a strided memory view to the stream.

Data is written sequentially from the stream, but is read respecting the striding requirements of the view.

Parameters

memoryView The memory view to read data to.

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

◆ write() [3/5]

size_t CeresEngine::FilteredOutputStream::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.

◆ write() [4/5]

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

virtual

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.

◆ write() [5/5]

template<typename T >
requires std::is_trivially_copyable_v<T>

bool CeresEngine::IOutputStream::write ( T value )

inline

Writes a trivially copyable object to the stream.

Template Parameters

T	The trivially copyable object type to be written.

Parameters

value The trivially copyable object value to be written.

Member Data Documentation

◆ mOutputStream

OutputStream CeresEngine::FilteredOutputStream::mOutputStream

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FilteredOutputStream() [1/2]

◆ FilteredOutputStream() [2/2]

◆ ~FilteredOutputStream()

Member Function Documentation

◆ flush()

◆ getOutputStream() [1/2]

◆ getOutputStream() [2/2]

◆ isSeekable()

◆ isSizeKnown()

◆ isTellable()

◆ isWritable()

◆ seek()

◆ size()

◆ tell()

◆ write() [1/5]

◆ write() [2/5]

◆ write() [3/5]

◆ write() [4/5]

◆ write() [5/5]

Member Data Documentation

◆ mOutputStream