cqsp::asset::IVirtualFileSystem Class Reference

The main functionality for this is to read files, so writing to files will not really be supported. More...

#include <vfs.h>

Inheritance diagram for cqsp::asset::IVirtualFileSystem:

Public Member Functions
	IVirtualFileSystem ()
virtual	~IVirtualFileSystem ()
virtual bool	Initialize ()=0
virtual IVirtualFilePtr	Open (const std::string &path, FileModes modes=Text)=0
	Opens file from the filesystem. Returns nullptr if file is invalid More...
virtual void	Close (IVirtualFilePtr &)=0
	Closes the file. More...
virtual IVirtualDirectoryPtr	OpenDirectory (const std::string &path)=0
	Lists all the files in the directory and subdirectories. Returns nullptr if path does not exist or is not a directory. More...
virtual bool	IsFile (const std::string &path)=0
	Is the file a file More...
virtual bool	IsDirectory (const std::string &path)=0
	Is the file a directory </summary More...
virtual bool	Exists (const std::string &path)=0
	Does the file exist More...

Detailed Description

The main functionality for this is to read files, so writing to files will not really be supported.

Constructor & Destructor Documentation

IVirtualFileSystem()

cqsp::asset::IVirtualFileSystem::IVirtualFileSystem ( )

inline

~IVirtualFileSystem()

virtual cqsp::asset::IVirtualFileSystem::~IVirtualFileSystem ( )

inlinevirtual

Member Function Documentation

Close()

virtual void cqsp::asset::IVirtualFileSystem::Close ( IVirtualFilePtr &  )

pure virtual

Closes the file.

Implemented in cqsp::asset::NativeFileSystem.

Exists()

virtual bool cqsp::asset::IVirtualFileSystem::Exists ( const std::string &  path )

pure virtual

Does the file exist

Implemented in cqsp::asset::NativeFileSystem.

Initialize()

virtual bool cqsp::asset::IVirtualFileSystem::Initialize ( )

pure virtual

Implemented in cqsp::asset::NativeFileSystem.

IsDirectory()

virtual bool cqsp::asset::IVirtualFileSystem::IsDirectory ( const std::string &  path )

pure virtual

Is the file a directory </summary

Implemented in cqsp::asset::NativeFileSystem.

IsFile()

virtual bool cqsp::asset::IVirtualFileSystem::IsFile ( const std::string &  path )

pure virtual

Is the file a file

Implemented in cqsp::asset::NativeFileSystem.

Open()

virtual IVirtualFilePtr cqsp::asset::IVirtualFileSystem::Open ( const std::string &  path, FileModes  modes = Text  )

pure virtual

Opens file from the filesystem. Returns nullptr if file is invalid

Implemented in cqsp::asset::NativeFileSystem.

OpenDirectory()

virtual IVirtualDirectoryPtr cqsp::asset::IVirtualFileSystem::OpenDirectory ( const std::string &  path )

pure virtual

Lists all the files in the directory and subdirectories. Returns nullptr if path does not exist or is not a directory.

Implemented in cqsp::asset::NativeFileSystem.

---

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

• /github/workspace/src/engine/asset/vfs/vfs.h