Inherits AZ::IO::GenericStream.

Public Member Functions
	SystemFileStream ()

	SystemFileStream (const char *path, OpenMode mode)
	Opens a SystemFile stream using the specific path and OpenMode.

	SystemFileStream (SystemFile &&file)
	SystemFiles are only movable and only one instance is available at a time.

	SystemFileStream (SystemFile &&file, OpenMode mode)

	SystemFileStream (SystemFileStream &&)
	Move constructor and assignment which is defaulted in the cpp file.

SystemFileStream &	operator= (SystemFileStream &&)

bool	Open (const char *path, OpenMode mode)

void	Close () override

bool	IsOpen () const override

bool	CanSeek () const override

bool	CanRead () const override

bool	CanWrite () const override

void	Seek (OffsetType bytes, SeekMode mode) override

SizeType	Read (SizeType bytes, void *oBuffer) override

SizeType	Write (SizeType bytes, const void *iBuffer) override

SizeType	GetCurPos () const override

SizeType	GetLength () const override

const char *	GetFilename () const override

OpenMode	GetModeFlags () const override

bool	ReOpen () override

SystemFile	MoveSystemFile () &&
	Moves a SystemFile instance from an rvalue or xvalue SystemFileStream.

Public Member Functions inherited from AZ::IO::GenericStream
virtual bool	IsOpen () const =0

virtual bool	CanSeek () const =0

virtual bool	CanRead () const =0

virtual bool	CanWrite () const =0

virtual void	Seek (OffsetType bytes, SeekMode mode)=0

virtual SizeType	Read (SizeType bytes, void *oBuffer)=0

virtual SizeType	Write (SizeType bytes, const void *iBuffer)=0

virtual SizeType	WriteFromStream (SizeType bytes, GenericStream *inputStream)

virtual SizeType	GetCurPos () const =0

virtual SizeType	GetLength () const =0

virtual SizeType	ReadAtOffset (SizeType bytes, void *oBuffer, OffsetType offset=-1)

virtual SizeType	WriteAtOffset (SizeType bytes, const void *iBuffer, OffsetType offset=-1)

virtual bool	IsCompressed () const

virtual const char *	GetFilename () const

virtual OpenMode	GetModeFlags () const

virtual bool	ReOpen ()

virtual void	Close ()

Additional Inherited Members
Public Types inherited from AZ::IO::GenericStream
enum	SeekMode { ST_SEEK_BEGIN , ST_SEEK_CUR , ST_SEEK_END }

Static Public Attributes inherited from AZ::IO::GenericStream
static constexpr size_t	StreamToStreamCopyBufferSize = 256

Protected Member Functions inherited from AZ::IO::GenericStream
SizeType	ComputeSeekPosition (OffsetType bytes, SeekMode mode)

Constructor & Destructor Documentation

◆ SystemFileStream() [1/2]

AZ::IO::SystemFileStream::SystemFileStream ( )

Creates a SystemFile stream with an underlying SystemFile which is not open The Open() function can be used to Open the SystemFile

◆ SystemFileStream() [2/2]

AZ::IO::SystemFileStream::SystemFileStream	(	SystemFile &&	file,
		OpenMode	mode
	)

For this overload, the mode parameter is for passing the mode flags used to open the supplied SystemFile This purpose of the mmode parameter is only for use in the ReOpen() function to determine how to reopen the SystemFile