RE::BSResource::LooseFileStream Class Reference

#include <LooseFileStream.h>

Inheritance diagram for RE::BSResource::LooseFileStream:

Public Member Functions
	~LooseFileStream () override
ErrorCode	DoOpen () override
void	DoClose () override
ErrorCode	DoGetInfo (Info &a_info) override
void	DoClone (BSTSmartPointer< Stream > &a_out) const override
ErrorCode	DoRead (void *a_buffer, std::uint64_t a_toRead, std::uint64_t &a_read) const override
ErrorCode	DoWrite (const void *a_buffer, std::uint64_t a_toWrite, std::uint64_t &a_written) const override
ErrorCode	DoSeek (std::uint64_t a_toSeek, SeekMode a_mode, std::uint64_t &a_sought) const override
ErrorCode	DoSetEndOfStream () override
bool	DoGetName (BSFixedString &a_dst) const override
ErrorCode	DoCreateAsync (BSTSmartPointer< AsyncStream > &a_streamOut) const override
Public Member Functions inherited from RE::BSResource::Stream
	Stream ()
	Stream (const Stream &a_rhs)
	Stream (Stream &&a_rhs)
	Stream (std::uint32_t a_totalSize)
	~Stream () override=default
virtual void	DoClone (BSTSmartPointer< Stream > &a_out) const =0
virtual ErrorCode	DoRead (void *a_buffer, std::uint64_t a_toRead, std::uint64_t &a_read) const =0
virtual ErrorCode	DoWrite (const void *a_buffer, std::uint64_t a_toWrite, std::uint64_t &a_written) const =0
virtual ErrorCode	DoSeek (std::uint64_t a_toSeek, SeekMode a_mode, std::uint64_t &a_sought) const =0
virtual ErrorCode	DoSetEndOfStream ()
virtual bool	DoGetName (BSFixedString &a_dst) const
virtual ErrorCode	DoCreateAsync (BSTSmartPointer< AsyncStream > &a_streamOut) const
Public Member Functions inherited from RE::BSResource::StreamBase
	StreamBase ()
	StreamBase (const StreamBase &a_rhs)
	StreamBase (StreamBase &&a_rhs)
	StreamBase (std::uint32_t a_totalSize)
virtual	~StreamBase ()=default
virtual ErrorCode	DoOpen ()=0
virtual void	DoClose ()=0
virtual std::uint64_t	DoGetKey () const
virtual ErrorCode	DoGetInfo (Info &a_info)
	TES_HEAP_REDEFINE_NEW ()
std::uint32_t	DecRef ()
std::uint32_t	IncRef ()
bool	IsWritable () const

Static Public Member Functions
static LooseFileStream *	Create (BSFixedString a_prefix, BSFixedString a_dirName, BSFixedString a_fileName, std::uint32_t a_fileSize, bool a_readOnly, Location *a_location)

Public Attributes
Location *	location
std::uint64_t	filePos
void *	buffer
Public Attributes inherited from RE::BSResource::LooseFileStreamBase
BSFixedString	prefix
BSFixedString	dirName
BSFixedString	fileName
BSSystemFile	file
Public Attributes inherited from RE::BSResource::StreamBase
std::uint32_t	totalSize
std::uint32_t	flags

Static Public Attributes
static constexpr auto	RTTI = RTTI_BSResource____LooseFileStream
Static Public Attributes inherited from RE::BSResource::Stream
static constexpr auto	RTTI = RTTI_BSResource__Stream
Static Public Attributes inherited from RE::BSResource::StreamBase
static constexpr auto	RTTI = RTTI_BSResource__StreamBase

Additional Inherited Members
Public Types inherited from RE::BSResource::StreamBase
enum	: std::uint32_t { kWritable = 1 << 0 , kRefCountBeg = 0x1000 , kRefCountMask = (std::uint32_t)0xFFFFF000 }

Constructor & Destructor Documentation

~LooseFileStream()

RE::BSResource::LooseFileStream::~LooseFileStream ( )

override

Member Function Documentation

Create()

static LooseFileStream * RE::BSResource::LooseFileStream::Create ( BSFixedString  a_prefix, BSFixedString  a_dirName, BSFixedString  a_fileName, std::uint32_t  a_fileSize, bool  a_readOnly, Location *  a_location  )

static

DoClone()

void RE::BSResource::LooseFileStream::DoClone ( BSTSmartPointer< Stream > &  a_out ) const

overridevirtual

Implements RE::BSResource::Stream.

DoClose()

void RE::BSResource::LooseFileStream::DoClose ( )

overridevirtual

Implements RE::BSResource::StreamBase.

DoCreateAsync()

ErrorCode RE::BSResource::LooseFileStream::DoCreateAsync ( BSTSmartPointer< AsyncStream > &  a_streamOut ) const

overridevirtual

Reimplemented from RE::BSResource::Stream.

DoGetInfo()

ErrorCode RE::BSResource::LooseFileStream::DoGetInfo ( Info &  a_info )

overridevirtual

Reimplemented from RE::BSResource::StreamBase.

DoGetName()

bool RE::BSResource::LooseFileStream::DoGetName ( BSFixedString &  a_dst ) const

overridevirtual

Reimplemented from RE::BSResource::Stream.

DoOpen()

ErrorCode RE::BSResource::LooseFileStream::DoOpen ( )

overridevirtual

Implements RE::BSResource::StreamBase.

DoRead()

ErrorCode RE::BSResource::LooseFileStream::DoRead ( void *  a_buffer, std::uint64_t  a_toRead, std::uint64_t &  a_read  ) const

overridevirtual

Implements RE::BSResource::Stream.

DoSeek()

ErrorCode RE::BSResource::LooseFileStream::DoSeek ( std::uint64_t  a_toSeek, SeekMode  a_mode, std::uint64_t &  a_sought  ) const

overridevirtual

Implements RE::BSResource::Stream.

DoSetEndOfStream()

ErrorCode RE::BSResource::LooseFileStream::DoSetEndOfStream ( )

overridevirtual

Reimplemented from RE::BSResource::Stream.

DoWrite()

ErrorCode RE::BSResource::LooseFileStream::DoWrite ( const void *  a_buffer, std::uint64_t  a_toWrite, std::uint64_t &  a_written  ) const

overridevirtual

Implements RE::BSResource::Stream.

Member Data Documentation

buffer

void* RE::BSResource::LooseFileStream::buffer

filePos

std::uint64_t RE::BSResource::LooseFileStream::filePos

location

Location* RE::BSResource::LooseFileStream::location

RTTI

constexpr auto RE::BSResource::LooseFileStream::RTTI = RTTI_BSResource____LooseFileStream

inlinestaticconstexpr

---

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

• CommonLibSSE-NG/include/RE/L/LooseFileStream.h