RageFileObj Class Reference

Inheritance diagram for RageFileObj:

Collaboration diagram for RageFileObj:

Public Member Functions
	RageFileObj (const RageFileObj &cpy)
std::string	GetError () const override
void	ClearError () override
bool	AtEOF () const override
int	Seek (int iOffset) override
int	Seek (int offset, int whence) override
int	Tell () const override
int	Read (void *pBuffer, size_t iBytes) override
int	Read (std::string &buffer, int bytes=-1) override
int	Read (void *buffer, size_t bytes, int nmemb) override
int	Write (const void *pBuffer, size_t iBytes) override
int	Write (const std::string &sString) override
int	Write (const void *buffer, size_t bytes, int nmemb) override
int	Flush () override
int	GetLine (std::string &out) override
int	PutLine (const std::string &str) override
void	EnableCRC32 (bool on=true) override
bool	GetCRC32 (uint32_t *iRet) override
int	GetFileSize () const override=0
int	GetFD () override
std::string	GetDisplayPath () const override
RageFileBasic *	Copy () const override

Protected Member Functions
virtual int	SeekInternal (int)
virtual int	ReadInternal (void *pBuffer, size_t iBytes)=0
virtual int	WriteInternal (const void *pBuffer, size_t iBytes)=0
virtual int	FlushInternal ()
void	EnableReadBuffering ()
void	EnableWriteBuffering (int iBytes=1024 *64)
void	SetError (const std::string &sError)

Protected Attributes
std::string	m_sError

Member Function Documentation

AtEOF()

bool RageFileObj::AtEOF ( ) const

inlineoverridevirtual

Implements RageFileBasic.

ClearError()

void RageFileObj::ClearError ( )

inlineoverridevirtual

Implements RageFileBasic.

Copy()

RageFileBasic * RageFileObj::Copy ( ) const

inlineoverridevirtual

Implements RageFileBasic.

EnableCRC32()

void RageFileObj::EnableCRC32 ( bool  on = true )

overridevirtual

Implements RageFileBasic.

Flush()

int RageFileObj::Flush ( )

overridevirtual

Implements RageFileBasic.

GetCRC32()

bool RageFileObj::GetCRC32 ( uint32_t *  iRet )

overridevirtual

Implements RageFileBasic.

GetDisplayPath()

std::string RageFileObj::GetDisplayPath ( ) const

inlineoverridevirtual

Reimplemented from RageFileBasic.

GetError()

std::string RageFileObj::GetError ( ) const

inlineoverridevirtual

Implements RageFileBasic.

GetFD()

int RageFileObj::GetFD ( )

inlineoverridevirtual

Implements RageFileBasic.

GetFileSize()

int RageFileObj::GetFileSize ( ) const

overridepure virtual

Implements RageFileBasic.

GetLine()

int RageFileObj::GetLine ( std::string &  out )

overridevirtual

Implements RageFileBasic.

PutLine()

int RageFileObj::PutLine ( const std::string &  str )

overridevirtual

Implements RageFileBasic.

Read() [1/3]

int RageFileObj::Read ( std::string &  buffer, int  bytes = -1  )

overridevirtual

Implements RageFileBasic.

Read() [2/3]

int RageFileObj::Read ( void *  buffer, size_t  bytes, int  nmemb  )

overridevirtual

Implements RageFileBasic.

Read() [3/3]

int RageFileObj::Read ( void *  pBuffer, size_t  iBytes  )

overridevirtual

Implements RageFileBasic.

Seek() [1/2]

int RageFileObj::Seek ( int  iOffset )

overridevirtual

Implements RageFileBasic.

Seek() [2/2]

int RageFileObj::Seek ( int  offset, int  whence  )

overridevirtual

Implements RageFileBasic.

Tell()

int RageFileObj::Tell ( ) const

inlineoverridevirtual

Implements RageFileBasic.

Write() [1/3]

int RageFileObj::Write ( const std::string &  sString )

inlineoverridevirtual

Implements RageFileBasic.

Write() [2/3]

int RageFileObj::Write ( const void *  buffer, size_t  bytes, int  nmemb  )

overridevirtual

Implements RageFileBasic.

Write() [3/3]

int RageFileObj::Write ( const void *  pBuffer, size_t  iBytes  )

overridevirtual

Implements RageFileBasic.

---

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

• /home/runner/work/etterna/etterna/src/RageUtil/File/RageFileBasic.h
• /home/runner/work/etterna/etterna/src/RageUtil/File/RageFileBasic.cpp