Etterna: RageFile Class Reference

Etterna 0.74.4

Loading...

Searching...

No Matches

High-level file access. More...

#include <RageFile.h>

Inheritance diagram for RageFile:

Inheritance graph

[legend]

Collaboration diagram for RageFile:

Collaboration graph

[legend]

Public Types
enum	{ READ = 0x1 , WRITE = 0x2 , STREAMED = 0x4 , SLOW_FLUSH = 0x8 }

Public Member Functions
	RageFile (const RageFile &cpy)

RageFile *	Copy () const override

const std::string &	GetRealPath () const

std::string	GetPath () const

bool	Open (const std::string &path, int mode=READ)

void	Close ()

bool	IsOpen () const

int	GetMode () const

bool	AtEOF () const override

std::string	GetError () const override

void	ClearError () override

int	Tell () const override

int	Seek (int offset) override

int	GetFileSize () const override

int	GetFD () override

int	Read (void *buffer, size_t bytes) override

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

int	Write (const void *buffer, size_t bytes) override

int	Write (const std::string &string) override

int	Flush () override

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

int	Read (void *buffer, size_t bytes, int nmemb) override

int	Seek (int offset, int whence) 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

virtual void	PushSelf (lua_State *L)

Public Member Functions inherited from RageFileBasic
virtual std::string	GetDisplayPath () const

Detailed Description

High-level file access.

This is the high-level interface, which interfaces with RageFileObj implementations and RageFileManager.

Member Function Documentation

◆ AtEOF()

bool RageFile::AtEOF ( ) const

overridevirtual

Implements RageFileBasic.

◆ ClearError()

void RageFile::ClearError ( )

overridevirtual

Implements RageFileBasic.

◆ Copy()

RageFile * RageFile::Copy ( ) const

overridevirtual

Implements RageFileBasic.

◆ EnableCRC32()

void RageFile::EnableCRC32 ( bool on = true )

overridevirtual

Implements RageFileBasic.

◆ Flush()

int RageFile::Flush ( )

overridevirtual

Implements RageFileBasic.

◆ GetCRC32()

bool RageFile::GetCRC32 ( uint32_t * iRet )

overridevirtual

Implements RageFileBasic.

◆ GetError()

std::string RageFile::GetError ( ) const

overridevirtual

Implements RageFileBasic.

◆ GetFD()

int RageFile::GetFD ( )

overridevirtual

Implements RageFileBasic.

◆ GetFileSize()

int RageFile::GetFileSize ( ) const

overridevirtual

Implements RageFileBasic.

◆ GetLine()

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

overridevirtual

Implements RageFileBasic.

◆ PutLine()

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

overridevirtual

Implements RageFileBasic.

◆ Read() [1/3]

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

overridevirtual

Implements RageFileBasic.

◆ Read() [2/3]

int RageFile::Read	(	void *	buffer,
		size_t	bytes
	)

overridevirtual

Implements RageFileBasic.

◆ Read() [3/3]

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

overridevirtual

Implements RageFileBasic.

◆ Seek() [1/2]

int RageFile::Seek ( int offset )

overridevirtual

Implements RageFileBasic.

◆ Seek() [2/2]

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

overridevirtual

Implements RageFileBasic.

◆ Tell()

int RageFile::Tell ( ) const

overridevirtual

Implements RageFileBasic.

◆ Write() [1/3]

int RageFile::Write ( const std::string & string )

inlineoverridevirtual

Implements RageFileBasic.

◆ Write() [2/3]

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

overridevirtual

Implements RageFileBasic.

◆ Write() [3/3]

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

overridevirtual

Implements RageFileBasic.

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

/home/runner/work/etterna/etterna/src/RageUtil/File/RageFile.h
/home/runner/work/etterna/etterna/src/RageUtil/File/RageFile.cpp