ezMemoryStreamContainerStorage< CONTAINER > Class Template Reference

Templated implementation of ezMemoryStreamStorageInterface that adapts most standard ez containers to the interface. More...

#include <MemoryStream.h>

Inheritance diagram for ezMemoryStreamContainerStorage< CONTAINER >:

Public Member Functions
	ezMemoryStreamContainerStorage (ezUInt32 uiInitialCapacity=0, ezAllocator *pAllocator=ezFoundation::GetDefaultAllocator())
	Creates the storage object for a memory stream. Use uiInitialCapacity to reserve some memory up front.
virtual ezUInt64	GetStorageSize64 () const override
	Returns the number of bytes that are currently stored.
virtual void	Clear () override
	Clears the entire storage. All readers and writers must be reset to start from the beginning again.
virtual void	Compact () override
	Deallocates any allocated memory that's not needed to hold the currently stored data.
virtual ezUInt64	GetHeapMemoryUsage () const override
	Returns the amount of bytes that are currently allocated on the heap.
virtual void	Reserve (ezUInt64 uiBytes) override
	Reserves N bytes of storage.
virtual ezResult	CopyToStream (ezStreamWriter &inout_stream) const override
	Writes the entire content of the storage to the provided stream.
virtual ezArrayPtr< const ezUInt8 >	GetContiguousMemoryRange (ezUInt64 uiStartByte) const override
	Returns a read-only ezArrayPtr that represents a contiguous area in memory which starts at the given first byte. More...
virtual ezArrayPtr< ezUInt8 >	GetContiguousMemoryRange (ezUInt64 uiStartByte) override
	Non-const overload of GetContiguousMemoryRange().
const ezUInt8 *	GetData () const
	The data is guaranteed to be contiguous.
Public Member Functions inherited from ezMemoryStreamStorageInterface
ezUInt32	GetStorageSize32 () const
	Returns the number of bytes that are currently stored. Asserts that the stored amount is less than 4GB.
void	ReadAll (ezStreamReader &inout_stream, ezUInt64 uiMaxBytes=ezMath::MaxValue< ezUInt64 >())
	Copies all data from the given stream into the storage.

Detailed Description

template<typename CONTAINER>
class ezMemoryStreamContainerStorage< CONTAINER >

Templated implementation of ezMemoryStreamStorageInterface that adapts most standard ez containers to the interface.

Note that ezMemoryStreamContainerStorage assumes contiguous storage, so using an ezDeque for storage will not work.

Member Function Documentation

GetContiguousMemoryRange()

template<typename CONTAINER >

virtual ezArrayPtr<const ezUInt8> ezMemoryStreamContainerStorage< CONTAINER >::GetContiguousMemoryRange ( ezUInt64  uiStartByte ) const

inlineoverridevirtual

Returns a read-only ezArrayPtr that represents a contiguous area in memory which starts at the given first byte.

This piece of memory can be read/copied/modified in one operation (memcpy etc). The next byte after this slice may be located somewhere entirely different in memory. Call GetContiguousMemoryRange() again with the next byte after this range, to get access to the next memory area.

Chunks may differ in size.

Implements ezMemoryStreamStorageInterface.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/IO/MemoryStream.h