CeresEngine::IResourceInputStream Class Reference

A specialized InputStream for a ResourceStream. More...

#include <CeresEngine/Resource/ResourceStream.hpp>

Inheritance diagram for CeresEngine::IResourceInputStream:

Private Types
using	super = ResourceStream

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...
Public Member Functions inherited from CeresEngine::ResourceStream
	ResourceStream (ResourceStreamLock &&lock)
HResource	getResource () const
	Gets the resource to which this stream belongs to.
ResourceManager *	getResourceManager () const
	Gets the resource manager of the resource that owns 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
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.
Public Member Functions inherited from CeresEngine::IInputStream
virtual bool	isReadable () const noexcept
	Checks if the stream is readable.
virtual size_t	read (void *data, size_t n)
	Reads data from the data stream to a buffer of raw memory data with length n.
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.

Detailed Description

A specialized InputStream for a ResourceStream.

Member Typedef Documentation

super

using CeresEngine::IResourceInputStream::super = ResourceStream

private

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Resource/ResourceStream.hpp