eve::filesystem::physfs::File类 参考

File public API. 更多...

#include <File.h>

类 eve::filesystem::physfs::File 继承关系图:

Public 成员函数
	File (std::string filename)
	Constructs an File with the given ilename.
virtual	~File ()
	Releases File resources.
bool	open (std::string mode) override
	Opens open.
bool	close () override
	Closes close.
bool	isOpen () const override
	True when open.
int64_t	getSize () override
	Byte length of the owned buffer.
int64_t	read (void *dst, int64_t size) override
	Reads read.
bool	write (const void *data, int64_t size) override
	Writes write.
bool	flush () override
	Flushes flush.
bool	isEOF () override
	True when eof.
int64_t	tell () override
	Returns the current tell.
bool	seek (uint64_t pos) override
	Seeks seek.
bool	setBuffer (std::string bufmode, int64_t size) override
	Sets the buffer.
std::string	getBuffer (int64_t &size) const override
	Returns the buffer.
std::string	getMode () const override
	Returns the mode.
std::string	getFilename () const override
	Full filename including extension.
Public 成员函数 继承自 eve::filesystem::File
virtual FileData *	read (int64_t size=ALL)
	Reads data from the file and allocates a Data object.
virtual bool	write (const Data *data, int64_t size=ALL)
	Writes a Data object into the File.
virtual std::string	getExtension () const
	Gets the file extension for this File, or empty string if none.

额外继承的成员函数
静态 Public 属性 继承自 eve::filesystem::File
static const int64_t	ALL = -1
	Used to indicate ALL data in a file.

详细描述

File public API.

在文件 File.h 第 17 行定义.

构造及析构函数说明

File()

eve::filesystem::physfs::File::File

(

std::string

filename

)

Constructs an File with the given ilename.

参数

filename

The relative filepath of the file to load.

在文件 File.cpp 第 21 行定义.

~File()

eve::filesystem::physfs::File::~File ( )

virtual

Releases File resources.

重载 eve::filesystem::File .

在文件 File.cpp 第 24 行定义.

引用了 close().

成员函数说明

close()

bool eve::filesystem::physfs::File::close ( )

overridevirtual

Closes close.

实现了 eve::filesystem::File.

在文件 File.cpp 第 78 行定义.

被这些函数引用 getSize() , 以及 ~File().

flush()

bool eve::filesystem::physfs::File::flush ( )

overridevirtual

Flushes flush.

实现了 eve::filesystem::File.

在文件 File.cpp 第 138 行定义.

被这些函数引用 write().

getBuffer()

std::string eve::filesystem::physfs::File::getBuffer ( int64_t &  size ) const

overridevirtual

Returns the buffer.

实现了 eve::filesystem::File.

在文件 File.cpp 第 191 行定义.

引用了 size.

getFilename()

std::string eve::filesystem::physfs::File::getFilename ( ) const

overridevirtual

Full filename including extension.

实现了 eve::filesystem::File.

在文件 File.cpp 第 196 行定义.

getMode()

std::string eve::filesystem::physfs::File::getMode ( ) const

overridevirtual

Returns the mode.

实现了 eve::filesystem::File.

在文件 File.cpp 第 198 行定义.

getSize()

int64_t eve::filesystem::physfs::File::getSize ( )

overridevirtual

Byte length of the owned buffer.

实现了 eve::filesystem::File.

在文件 File.cpp 第 89 行定义.

引用了 close(), open() , 以及 size.

isEOF()

bool eve::filesystem::physfs::File::isEOF ( )

overridevirtual

True when eof.

实现了 eve::filesystem::File.

在文件 File.cpp 第 154 行定义.

引用了 eve::filesystem::physfs::test_eof().

isOpen()

bool eve::filesystem::physfs::File::isOpen ( ) const

overridevirtual

True when open.

实现了 eve::filesystem::File.

在文件 File.cpp 第 87 行定义.

被这些函数引用 setBuffer().

open()

bool eve::filesystem::physfs::File::open ( std::string  mode )

overridevirtual

Opens open.

实现了 eve::filesystem::File.

在文件 File.cpp 第 28 行定义.

引用了 handle , 以及 setBuffer().

被这些函数引用 getSize().

read()

int64_t eve::filesystem::physfs::File::read ( void *  dst, int64_t  size  )

overridevirtual

Reads read.

实现了 eve::filesystem::File.

在文件 File.cpp 第 102 行定义.

引用了 eve::filesystem::File::ALL, max , 以及 size.

seek()

bool eve::filesystem::physfs::File::seek ( uint64_t  pos )

overridevirtual

Seeks seek.

实现了 eve::filesystem::File.

在文件 File.cpp 第 162 行定义.

引用了 pos.

setBuffer()

bool eve::filesystem::physfs::File::setBuffer ( std::string  bufmode, int64_t  size  )

overridevirtual

Sets the buffer.

实现了 eve::filesystem::File.

在文件 File.cpp 第 164 行定义.

引用了 isOpen() , 以及 size.

被这些函数引用 open().

tell()

int64_t eve::filesystem::physfs::File::tell ( )

overridevirtual

Returns the current tell.

实现了 eve::filesystem::File.

在文件 File.cpp 第 156 行定义.

write()

bool eve::filesystem::physfs::File::write ( const void *  data, int64_t  size  )

overridevirtual

Writes write.

实现了 eve::filesystem::File.

在文件 File.cpp 第 119 行定义.

引用了 flush() , 以及 size.

---

该类的文档由以下文件生成:

• src/modules/filesystem/physfs/File.h
• src/modules/filesystem/physfs/File.cpp