#include <UnixPlatformFile.h>

Inheritance diagram for FUnixPlatformFile:

Public Member Functions
AUTORTFM_OPEN virtual CORE_API bool	FileExists (const TCHAR *Filename) override

virtual CORE_API int64	FileSize (const TCHAR *Filename) override

virtual CORE_API bool	DeleteFile (const TCHAR *Filename) override

virtual CORE_API bool	IsReadOnly (const TCHAR *Filename) override

virtual CORE_API bool	MoveFile (const TCHAR To, const TCHAR From) override

virtual CORE_API bool	SetReadOnly (const TCHAR *Filename, bool bNewReadOnlyValue) override

virtual CORE_API FDateTime	GetTimeStamp (const TCHAR *Filename) override

virtual CORE_API void	SetTimeStamp (const TCHAR *Filename, const FDateTime DateTime) override

virtual CORE_API FDateTime	GetAccessTimeStamp (const TCHAR *Filename) override

virtual CORE_API FString	GetFilenameOnDisk (const TCHAR *Filename) override

virtual CORE_API ESymlinkResult	IsSymlink (const TCHAR *Filename) override

virtual CORE_API IFileHandle *	OpenRead (const TCHAR *Filename, bool bAllowWrite=false) override

virtual CORE_API IFileHandle *	OpenWrite (const TCHAR *Filename, bool bAppend=false, bool bAllowRead=false) override

virtual CORE_API FOpenMappedResult	OpenMappedEx (const TCHAR *Filename, EOpenReadFlags OpenOptions=EOpenReadFlags::None, int64 MaximumSize=0) override

virtual CORE_API bool	DirectoryExists (const TCHAR *Directory) override

virtual CORE_API bool	CreateDirectory (const TCHAR *Directory) override

virtual CORE_API bool	DeleteDirectory (const TCHAR *Directory) override

virtual CORE_API FFileStatData	GetStatData (const TCHAR *FilenameOrDirectory) override

CORE_API bool	CreateDirectoriesFromPath (const TCHAR *Path)

virtual CORE_API bool	IterateDirectory (const TCHAR *Directory, FDirectoryVisitor &Visitor) override

virtual CORE_API bool	IterateDirectoryStat (const TCHAR *Directory, FDirectoryStatVisitor &Visitor) override

virtual CORE_API bool	CopyFile (const TCHAR To, const TCHAR From, EPlatformFileRead ReadFlags=EPlatformFileRead::None, EPlatformFileWrite WriteFlags=EPlatformFileWrite::None) override

Public Member Functions inherited from IPhysicalPlatformFile
virtual bool	ShouldBeUsed (IPlatformFile Inner, const TCHAR CmdLine) const override

virtual CORE_API bool	Initialize (IPlatformFile Inner, const TCHAR CmdLine) override

virtual IPlatformFile *	GetLowerLevel () override

virtual void	SetLowerLevel (IPlatformFile *NewLowerLevel) override

virtual const TCHAR *	GetName () const override

Public Member Functions inherited from IPlatformFile
CORE_API	IPlatformFile ()

virtual CORE_API	~IPlatformFile ()

virtual void	SetSandboxEnabled (bool bInEnabled)

virtual bool	IsSandboxEnabled () const

virtual void	InitializeAfterSetActive ()

virtual void	InitializeAfterProjectFilePath ()

virtual void	MakeUniquePakFilesForTheseFiles (const TArray< TArray< FString > > &InFiles)

virtual void	InitializeNewAsyncIO ()

virtual void	AddLocalDirectories (TArray< FString > &LocalDirectories)

virtual void	BypassSecurity (bool bInBypass)

virtual void	Tick ()

virtual bool	DeleteFiles (const TArrayView< const TCHAR * > &Filenames)

virtual bool	HasMarkOfTheWeb (FStringView Filename, FString *OutSourceURL=nullptr)

virtual bool	SetMarkOfTheWeb (FStringView Filename, bool bNewStatus, const FString *InSourceURL=nullptr)

virtual CORE_API FFileOpenResult	OpenRead (const TCHAR *Filename, EOpenReadFlags Flags)

virtual FFileOpenResult	OpenReadNoBuffering (const TCHAR *Filename, EOpenReadFlags Flags)

virtual IFileHandle *	OpenReadNoBuffering (const TCHAR *Filename, bool bAllowWrite=false)

virtual CORE_API FFileOpenResult	OpenWrite (const TCHAR *Filename, EOpenWriteFlags Flags)

virtual CORE_API bool	FileJournalIsAvailable (const TCHAR VolumeOrPath=nullptr, ELogVerbosity::Type OutErrorLevel=nullptr, FString *OutError=nullptr)

virtual CORE_API uint64	FileJournalGetMaximumSize (const TCHAR VolumeOrPath=nullptr, ELogVerbosity::Type OutErrorLevel=nullptr, FString *OutError=nullptr) const

virtual CORE_API EFileJournalResult	FileJournalGetLatestEntry (const TCHAR VolumeName, FFileJournalId &OutJournalId, FFileJournalEntryHandle &OutEntryHandle, FString OutError=nullptr)

virtual CORE_API bool	FileJournalIterateDirectory (const TCHAR Directory, FDirectoryJournalVisitorFunc Visitor, FString OutError=nullptr)

virtual CORE_API FFileJournalData	FileJournalGetFileData (const TCHAR FilenameOrDirectory, FString OutError=nullptr)

virtual CORE_API EFileJournalResult	FileJournalReadModified (const TCHAR VolumeName, const FFileJournalId &JournalIdOfStartingEntry, const FFileJournalEntryHandle &StartingJournalEntry, TMap< FFileJournalFileHandle, FString > &KnownDirectories, TSet< FString > &OutModifiedDirectories, FFileJournalEntryHandle &OutNextJournalEntry, FString OutError=nullptr)

virtual CORE_API FString	FileJournalGetVolumeName (FStringView InPath)

virtual CORE_API FFileOpenAsyncResult	OpenAsyncRead (const TCHAR *Filename, EOpenReadFlags Flags)

virtual CORE_API IAsyncReadFileHandle *	OpenAsyncRead (const TCHAR *Filename, bool bAllowWrite=false)

virtual void	SetAsyncMinimumPriority (EAsyncIOPriorityAndFlags MinPriority)

virtual CORE_API IMappedFileHandle *	OpenMapped (const TCHAR *Filename)

virtual CORE_API void	GetTimeStampPair (const TCHAR PathA, const TCHAR PathB, FDateTime &OutTimeStampA, FDateTime &OutTimeStampB)

virtual CORE_API FDateTime	GetTimeStampLocal (const TCHAR *Filename)

virtual CORE_API bool	IterateDirectory (const TCHAR *Directory, FDirectoryVisitorFunc Visitor)

virtual CORE_API bool	IterateDirectoryStat (const TCHAR *Directory, FDirectoryStatVisitorFunc Visitor)

virtual CORE_API bool	IterateDirectoryRecursively (const TCHAR *Directory, FDirectoryVisitor &Visitor)

virtual CORE_API bool	IterateDirectoryStatRecursively (const TCHAR *Directory, FDirectoryStatVisitor &Visitor)

virtual CORE_API bool	IterateDirectoryRecursively (const TCHAR *Directory, FDirectoryVisitorFunc Visitor)

virtual CORE_API bool	IterateDirectoryStatRecursively (const TCHAR *Directory, FDirectoryStatVisitorFunc Visitor)

virtual CORE_API void	FindFiles (TArray< FString > &FoundFiles, const TCHAR Directory, const TCHAR FileExtension)

virtual CORE_API void	FindFilesRecursively (TArray< FString > &FoundFiles, const TCHAR Directory, const TCHAR FileExtension)

virtual CORE_API bool	DeleteDirectoryRecursively (const TCHAR *Directory)

virtual CORE_API bool	CreateDirectoryTree (const TCHAR *Directory)

virtual CORE_API bool	CopyDirectoryTree (const TCHAR DestinationDirectory, const TCHAR Source, bool bOverwriteAllExisting)

virtual CORE_API FString	ConvertToAbsolutePathForExternalAppForRead (const TCHAR *Filename)

virtual CORE_API FString	ConvertToAbsolutePathForExternalAppForWrite (const TCHAR *Filename)

virtual bool	SendMessageToServer (const TCHAR Message, IFileServerMessageHandler Handler)

virtual bool	DoesCreatePublicFiles ()

virtual void	SetCreatePublicFiles (bool bCreatePublicFiles)

virtual int64	GetAllowedBytesToWriteThrottledStorage (const TCHAR *DestinationPath=nullptr)

Protected Member Functions
virtual CORE_API FString	NormalizeFilename (const TCHAR *Filename, bool bIsForWriting)

virtual CORE_API FString	NormalizeDirectory (const TCHAR *Directory, bool bIsForWriting)

CORE_API bool	IterateDirectoryCommon (const TCHAR Directory, const TFunctionRef< bool(struct dirent )> &Visitor)

Protected Attributes
bool	bLoggingError = false

Additional Inherited Members
Public Types inherited from IPlatformFile
enum class	EOpenReadFlags : uint8 { None = 0 , AllowWrite = 1 << 0 , AllowDelete = 1 << 1 , NoBuffering = 1 << 2 }

enum class	EOpenWriteFlags : uint8 { None = 0 , AllowRead = 1 << 0 , Append = 1 << 1 }

typedef TFunctionRef< bool(const TCHAR *, bool)>	FDirectoryVisitorFunc

typedef TFunctionRef< bool(const TCHAR *, const FFileStatData &)>	FDirectoryStatVisitorFunc

typedef TFunctionRef< bool(const TCHAR *, const FFileJournalData &)>	FDirectoryJournalVisitorFunc

Static Public Member Functions inherited from IPlatformFile
static CORE_API IPlatformFile &	GetPlatformPhysical ()

static CORE_API const TCHAR *	GetPhysicalTypeName ()

Detailed Description

Unix File I/O implementation

Member Function Documentation

◆ CopyFile()

bool FUnixPlatformFile::CopyFile	(	const TCHAR *	To,
		const TCHAR *	From,
		EPlatformFileRead	ReadFlags = `EPlatformFileRead::None`,
		EPlatformFileWrite	WriteFlags = `EPlatformFileWrite::None`
	)

overridevirtual

Copy a file. This will fail if the destination file already exists.

Parameters

To	File to copy to.
From	File to copy from.
ReadFlags	Source file read options.
WriteFlags	Destination file write options.

Returns: true if the file was copied successfully.

Reimplemented from IPlatformFile.

◆ CreateDirectoriesFromPath()

bool FUnixPlatformFile::CreateDirectoriesFromPath ( const TCHAR * Path )

◆ CreateDirectory()

bool FUnixPlatformFile::CreateDirectory ( const TCHAR * Directory )

overridevirtual

Create a directory and return true if the directory was created or already existed.

Implements IPlatformFile.

◆ DeleteDirectory()

bool FUnixPlatformFile::DeleteDirectory ( const TCHAR * Directory )

overridevirtual

Delete a directory and return true if the directory was deleted or otherwise does not exist.

Implements IPlatformFile.

◆ DeleteFile()

bool FUnixPlatformFile::DeleteFile ( const TCHAR * Filename )

overridevirtual

Delete a file and return true if the file exists. Will not delete read only files.

Implements IPlatformFile.

◆ DirectoryExists()

bool FUnixPlatformFile::DirectoryExists ( const TCHAR * Directory )

overridevirtual

Return true if the directory exists.

Implements IPlatformFile.

◆ FileExists()

bool FUnixPlatformFile::FileExists ( const TCHAR * Filename )

overridevirtual

Return true if the file exists.

Implements IPlatformFile.

◆ FileSize()

int64 FUnixPlatformFile::FileSize ( const TCHAR * Filename )

overridevirtual

Return the size of the file, or -1 if it doesn't exist.

Implements IPlatformFile.

◆ GetAccessTimeStamp()

FDateTime FUnixPlatformFile::GetAccessTimeStamp ( const TCHAR * Filename )

overridevirtual

Return the last access time of a file. Returns FDateTime::MinValue() on failure

Implements IPlatformFile.

◆ GetFilenameOnDisk()

FString FUnixPlatformFile::GetFilenameOnDisk ( const TCHAR * Filename )

overridevirtual

For case insensitive filesystems, returns the full path of the file with the same case as in the filesystem

Implements IPlatformFile.

◆ GetStatData()

FFileStatData FUnixPlatformFile::GetStatData ( const TCHAR * FilenameOrDirectory )

overridevirtual

Return the stat data for the given file or directory. Check the FFileStatData::bIsValid member before using the returned data

Implements IPlatformFile.

◆ GetTimeStamp()

FDateTime FUnixPlatformFile::GetTimeStamp ( const TCHAR * Filename )

overridevirtual

Return the modification time of a file. Returns FDateTime::MinValue() on failure

Implements IPlatformFile.

◆ IsReadOnly()

bool FUnixPlatformFile::IsReadOnly ( const TCHAR * Filename )

overridevirtual

Return true if the file is read only.

Implements IPlatformFile.

◆ IsSymlink()

ESymlinkResult FUnixPlatformFile::IsSymlink ( const TCHAR * Filename )

overridevirtual

Return true if the file is a symbolic link

Reimplemented from IPlatformFile.

◆ IterateDirectory()

bool FUnixPlatformFile::IterateDirectory	(	const TCHAR *	Directory,
		FDirectoryVisitor &	Visitor
	)

overridevirtual

Call the Visit function of the visitor once for each file or directory in a single directory. This function does not explore subdirectories.

Parameters

Directory	The directory to iterate the contents of.
Visitor	Visitor to call for each element of the directory

Returns: false if the directory did not exist or if the visitor returned false.

Implements IPlatformFile.

◆ IterateDirectoryCommon()

bool FUnixPlatformFile::IterateDirectoryCommon	(	const TCHAR *	Directory,
		const TFunctionRef< bool(struct dirent *)> &	Visitor
	)

protected

◆ IterateDirectoryStat()

bool FUnixPlatformFile::IterateDirectoryStat	(	const TCHAR *	Directory,
		FDirectoryStatVisitor &	Visitor
	)

overridevirtual

Call the Visit function of the visitor once for each file or directory in a single directory. This function does not explore subdirectories.

Parameters

Directory	The directory to iterate the contents of.
Visitor	Visitor to call for each element of the directory

Returns: false if the directory did not exist or if the visitor returned false.

Implements IPlatformFile.

◆ MoveFile()

bool FUnixPlatformFile::MoveFile	(	const TCHAR *	To,
		const TCHAR *	From
	)

overridevirtual

Attempt to move a file. Return true if successful. Will not overwrite existing files.

Implements IPlatformFile.

◆ NormalizeDirectory()

FString FUnixPlatformFile::NormalizeDirectory	(	const TCHAR *	Directory,
		bool	bIsForWriting
	)

protectedvirtual

◆ NormalizeFilename()

FString FUnixPlatformFile::NormalizeFilename	(	const TCHAR *	Filename,
		bool	bIsForWriting
	)

protectedvirtual

Unix File I/O implementation

◆ OpenMappedEx()

FOpenMappedResult FUnixPlatformFile::OpenMappedEx	(	const TCHAR *	Filename,
		EOpenReadFlags	OpenOptions = `EOpenReadFlags::None`,
		int64	MaximumSize = `0`
	)

overridevirtual

Open a file for async reading. This call does hit the disk; it is synchronous open.

Parameters

Filename	File to be mapped. This doesn't actually map anything, just opens the file.
OpenOptions	Allows specifying map to be writable via AllowWrite or be ReadOnly by deafault.

Returns: Close the file by deleting the handle. A non-null return value does mean the file exists. Null can be returned for many reasons even if the file exists. Perhaps this platform does not support mapped files, or this file is compressed in a pak file. Generally you attempt to open mapped, and if that fails, then use other file operations instead.

Reimplemented from IPlatformFile.

◆ OpenRead()

IFileHandle * FUnixPlatformFile::OpenRead	(	const TCHAR *	Filename,
		bool	bAllowWrite = `false`
	)

overridevirtual

Attempt to open a file for reading. Please consider using the new overload that takes EReadFlags instead of bools as parameters.

Parameters

Filename	file to be opened
bAllowWrite	(applies to certain platforms only) whether this file is allowed to be written to by other processes. This flag is needed to open files that are currently being written to as well.

Returns: If successful will return a non-nullptr pointer. Close the file by deleting the handle.

Implements IPlatformFile.

◆ OpenWrite()

IFileHandle * FUnixPlatformFile::OpenWrite	(	const TCHAR *	Filename,
		bool	bAppend = `false`,
		bool	bAllowRead = `false`
	)

overridevirtual

Attempt to open a file for writing. If successful will return a non-nullptr pointer. Close the file by deleting the handle.

Implements IPlatformFile.

◆ SetReadOnly()

bool FUnixPlatformFile::SetReadOnly	(	const TCHAR *	Filename,
		bool	bNewReadOnlyValue
	)

overridevirtual

Attempt to change the read only status of a file. Return true if successful.

Implements IPlatformFile.

◆ SetTimeStamp()

void FUnixPlatformFile::SetTimeStamp	(	const TCHAR *	Filename,
		const FDateTime	DateTime
	)

overridevirtual

Sets the modification time of a file

Implements IPlatformFile.

Member Data Documentation

◆ bLoggingError

bool FUnixPlatformFile::bLoggingError = false

protected

We're logging an error message.

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

Engine/Source/Runtime/Core/Public/Unix/UnixPlatformFile.h
Engine/Source/Runtime/Core/Private/Unix/UnixPlatformFile.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CopyFile()

◆ CreateDirectoriesFromPath()

◆ CreateDirectory()

◆ DeleteDirectory()

◆ DeleteFile()

◆ DirectoryExists()

◆ FileExists()

◆ FileSize()

◆ GetAccessTimeStamp()

◆ GetFilenameOnDisk()

◆ GetStatData()

◆ GetTimeStamp()

◆ IsReadOnly()

◆ IsSymlink()

◆ IterateDirectory()

◆ IterateDirectoryCommon()

◆ IterateDirectoryStat()

◆ MoveFile()

◆ NormalizeDirectory()

◆ NormalizeFilename()

◆ OpenMappedEx()

◆ OpenRead()

◆ OpenWrite()

◆ SetReadOnly()

◆ SetTimeStamp()

Member Data Documentation

◆ bLoggingError