Instances of this class act as storage for memory streams. More...

#include <MemoryStream.h>

Inheritance diagram for plMemoryStreamStorageInterface:

[legend]

Public Member Functions
plUInt32	GetStorageSize32 () const
	Returns the number of bytes that are currently stored. Asserts that the stored amount is less than 4GB.

virtual plUInt64	GetStorageSize64 () const =0
	Returns the number of bytes that are currently stored.

virtual void	Clear ()=0
	Clears the entire storage. All readers and writers must be reset to start from the beginning again.

virtual void	Compact ()=0
	Deallocates any allocated memory that's not needed to hold the currently stored data.

virtual plUInt64	GetHeapMemoryUsage () const =0
	Returns the amount of bytes that are currently allocated on the heap.

void	ReadAll (plStreamReader &inout_stream, plUInt64 uiMaxBytes=plMath::MaxValue< plUInt64 >())
	Copies all data from the given stream into the storage.

virtual void	Reserve (plUInt64 uiBytes)=0
	Reserves N bytes of storage.

virtual plResult	CopyToStream (plStreamWriter &inout_stream) const =0
	Writes the entire content of the storage to the provided stream.

virtual plArrayPtr< const plUInt8 >	GetContiguousMemoryRange (plUInt64 uiStartByte) const =0
	Returns a read-only plArrayPtr that represents a contiguous area in memory which starts at the given first byte.

virtual plArrayPtr< plUInt8 >	GetContiguousMemoryRange (plUInt64 uiStartByte)=0
	Non-const overload of GetContiguousMemoryRange().

Friends
class	plMemoryStreamReader

class	plMemoryStreamWriter

Detailed Description

Instances of this class act as storage for memory streams.

Member Function Documentation

◆ Clear()

virtual void plMemoryStreamStorageInterface::Clear ( )

pure virtual

Clears the entire storage. All readers and writers must be reset to start from the beginning again.

Implemented in plDefaultMemoryStreamStorage, plMemoryStreamContainerStorage< CONTAINER >, plMemoryStreamContainerStorage< plHybridArray< plUInt8, 256 > >, and plMemoryStreamContainerWrapperStorage< CONTAINER >.

◆ Compact()

virtual void plMemoryStreamStorageInterface::Compact ( )

pure virtual

Deallocates any allocated memory that's not needed to hold the currently stored data.

Implemented in plDefaultMemoryStreamStorage, plMemoryStreamContainerStorage< CONTAINER >, plMemoryStreamContainerStorage< plHybridArray< plUInt8, 256 > >, and plMemoryStreamContainerWrapperStorage< CONTAINER >.

◆ CopyToStream()

virtual plResult plMemoryStreamStorageInterface::CopyToStream ( plStreamWriter & inout_stream ) const

pure virtual

Writes the entire content of the storage to the provided stream.

Implemented in plDefaultMemoryStreamStorage, plMemoryStreamContainerStorage< CONTAINER >, plMemoryStreamContainerStorage< plHybridArray< plUInt8, 256 > >, and plMemoryStreamContainerWrapperStorage< CONTAINER >.

◆ GetContiguousMemoryRange() [1/2]

virtual plArrayPtr< const plUInt8 > plMemoryStreamStorageInterface::GetContiguousMemoryRange ( plUInt64 uiStartByte ) const

pure virtual

Returns a read-only plArrayPtr 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.

Implemented in plDefaultMemoryStreamStorage, plMemoryStreamContainerStorage< CONTAINER >, plMemoryStreamContainerStorage< plHybridArray< plUInt8, 256 > >, and plMemoryStreamContainerWrapperStorage< CONTAINER >.