CeresEngine::LimitedInputStream Class Reference

A input stream that filters another input stream and limit reads to up-to limit bytes. More...

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

Inheritance diagram for CeresEngine::LimitedInputStream:

Public Member Functions
	LimitedInputStream (InputStream stream, const std::size_t limit)
bool	isSeekable (Seek mode=Seek::Start) const noexcept override
	Checks if the stream is seekable.
void	seek (std::streamsize position, 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, size_t n) override
	Reads data from the data stream to a buffer of raw memory data with length n.
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.
virtual bool	invalidate ()
	In the stream is buffered, invalidates any buffered read data 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
virtual bool	isWritable () const noexcept
	Checks if the stream is writable.
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.
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.
virtual bool	flush ()
	In the stream is buffered, invalidates any buffered write data from to stream.

Private Attributes
InputStream	mStream
std::size_t	mLimit = 0
std::size_t	mPosition = 0

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 input stream that filters another input stream and limit reads to up-to limit bytes.

Constructor & Destructor Documentation

LimitedInputStream()

CeresEngine::LimitedInputStream::LimitedInputStream ( InputStream  stream, const std::size_t  limit  )

inline

Member Function Documentation

isReadable()

bool CeresEngine::LimitedInputStream::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::LimitedInputStream::isSeekable ( 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::LimitedInputStream::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::LimitedInputStream::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.

read()

size_t CeresEngine::LimitedInputStream::read ( void *  data, size_t  n  )

overridevirtual

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::LimitedInputStream::seek ( std::streamsize  position, 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::LimitedInputStream::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::LimitedInputStream::tell ( )

inlineoverridevirtual

Gets the absolute stream position, in bytes.

Note

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

Reimplemented from CeresEngine::IStream.

Member Data Documentation

mLimit

std::size_t CeresEngine::LimitedInputStream::mLimit = 0

private

mPosition

std::size_t CeresEngine::LimitedInputStream::mPosition = 0

private

mStream

InputStream CeresEngine::LimitedInputStream::mStream

private

---

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

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