uLang::IFileSystem Class Reference

#include <IFileSystem.h>

Inheritance diagram for uLang::IFileSystem:

Public Types
enum	EWriteFlags { None = 0 , EvenIfReadOnly }
using	CFileDirectoryVisitor = TFunction< bool(const char *, const char *, bool)>
using	CFileMemAllocator = TFunction< void *(size_t)>

Public Member Functions
virtual	~IFileSystem ()
virtual bool	IterateDirectory (const char *Directory, bool bRecurse, const CFileDirectoryVisitor &Visitor, bool bIsVisitorThreadSafe=false)=0
virtual bool	FileRead (const char *FilePath, const CFileMemAllocator &Allocator)=0
virtual bool	FileWrite (const char *FilePath, const char *Output, const size_t ByteSize, const EWriteFlags WriteFlags=EWriteFlags::None)=0
virtual bool	DeleteFile (const char *FilePath)=0
virtual bool	IsFileNewer (const char *FilePath, const char *ComparisonPath)=0
virtual bool	CopyFile (const char *SourcePath, const char *DestinationPath)=0
virtual bool	DoesFileExist (const char *FilePath)=0
virtual bool	GetFilenameOnDisk (const char *FilePath, CUTF8String &OutFilenameOnDisk)=0
virtual bool	CreateDirectory (const char *DirPath)=0
virtual bool	DeleteDirectory (const char *DirPath)=0
virtual bool	DoesDirectoryExist (const char *DirPath)=0
virtual bool	FindTempDir (CUTF8String &OutDir) const =0
virtual bool	MakeTempFile (CUTF8String &OutFilename)=0
virtual bool	GetCurrentWorkingDirectory (CUTF8String &OutWorkingDirectory)=0
virtual bool	SetCurrentWorkingDirectory (const char *DirPath)
virtual bool	IsReadOnly (const char *Filename)=0
virtual bool	SetReadOnly (const char *Filename, const bool bReadOnly)=0
Public Member Functions inherited from uLang::CSharedMix
	CSharedMix ()
virtual UE_API	~CSharedMix ()
	CSharedMix (const CSharedMix &Other)=delete
CSharedMix &	operator= (const CSharedMix &Other)=delete
uint32_t	GetRefCount () const

Additional Inherited Members
Static Protected Member Functions inherited from uLang::CSharedMix
template<class ObjectType >
static TSPtrG< ObjectType, false, CHeapRawAllocator >	SharedThis (ObjectType *This)
template<class ObjectType >
static TSPtrG< const ObjectType, false, CHeapRawAllocator >	SharedThis (const ObjectType *This)

Member Typedef Documentation

CFileDirectoryVisitor

using uLang::IFileSystem::CFileDirectoryVisitor = TFunction<bool(const char* , const char* , bool )>

CFileDirectoryVisitor

Returns

True to keep iterating, false to abort.

CFileMemAllocator

using uLang::IFileSystem::CFileMemAllocator = TFunction<void*(size_t )>

CFileMemAllocator

Returns

Buffer pointer to fill, null if the requested memory allocation failed or is disallowed.

Member Enumeration Documentation

EWriteFlags

enum uLang::IFileSystem::EWriteFlags

Enumerator
None
EvenIfReadOnly

Constructor & Destructor Documentation

~IFileSystem()

virtual uLang::IFileSystem::~IFileSystem ( )

inlinevirtual

Member Function Documentation

CopyFile()

virtual bool uLang::IFileSystem::CopyFile ( const char *  SourcePath, const char *  DestinationPath  )

pure virtual

CreateDirectory()

virtual bool uLang::IFileSystem::CreateDirectory ( const char *  DirPath )

pure virtual

DeleteDirectory()

virtual bool uLang::IFileSystem::DeleteDirectory ( const char *  DirPath )

pure virtual

DeleteFile()

virtual bool uLang::IFileSystem::DeleteFile ( const char *  FilePath )

pure virtual

DoesDirectoryExist()

virtual bool uLang::IFileSystem::DoesDirectoryExist ( const char *  DirPath )

pure virtual

DoesFileExist()

virtual bool uLang::IFileSystem::DoesFileExist ( const char *  FilePath )

pure virtual

FileRead()

virtual bool uLang::IFileSystem::FileRead ( const char *  FilePath, const CFileMemAllocator &  Allocator  )

pure virtual

FileWrite()

virtual bool uLang::IFileSystem::FileWrite ( const char *  FilePath, const char *  Output, const size_t  ByteSize, const EWriteFlags  WriteFlags = EWriteFlags::None  )

pure virtual

FindTempDir()

virtual bool uLang::IFileSystem::FindTempDir ( CUTF8String &  OutDir ) const

pure virtual

Retrieves the path of the directory designated for temporary files.

Parameters

OutDirectory

Storage for the directory path.

Returns

true if the directory was retrieved successfully, false otherwise.

GetCurrentWorkingDirectory()

virtual bool uLang::IFileSystem::GetCurrentWorkingDirectory ( CUTF8String &  OutWorkingDirectory )

pure virtual

GetFilenameOnDisk()

virtual bool uLang::IFileSystem::GetFilenameOnDisk ( const char *  FilePath, CUTF8String &  OutFilenameOnDisk  )

pure virtual

IsFileNewer()

virtual bool uLang::IFileSystem::IsFileNewer ( const char *  FilePath, const char *  ComparisonPath  )

pure virtual

IsReadOnly()

virtual bool uLang::IFileSystem::IsReadOnly ( const char *  Filename )

pure virtual

IterateDirectory()

virtual bool uLang::IFileSystem::IterateDirectory ( const char *  Directory, bool  bRecurse, const CFileDirectoryVisitor &  Visitor, bool  bIsVisitorThreadSafe = false  )

pure virtual

MakeTempFile()

virtual bool uLang::IFileSystem::MakeTempFile ( CUTF8String &  OutFilename )

pure virtual

Creates a temporary file. The name is guaranteed to be unique.

Parameters

OutFilename

Storage for the temporary filename.

Returns

true if the temporary file was created successfully, false otherwise.

SetCurrentWorkingDirectory()

virtual bool uLang::IFileSystem::SetCurrentWorkingDirectory ( const char *  DirPath )

inlinevirtual

Note that SetCurrentWorkingDirectory may not be implemented in some embeddings (e.g. Unreal).

SetReadOnly()

virtual bool uLang::IFileSystem::SetReadOnly ( const char *  Filename, const bool  bReadOnly  )

pure virtual

---

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

• Engine/Source/Runtime/VerseCompiler/Public/uLang/SourceProject/IFileSystem.h