#include <GenericPlatformFile.h>

Inheritance diagram for IPhysicalPlatformFile:

Public Member Functions
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	FileExists (const TCHAR *Filename)=0

virtual int64	FileSize (const TCHAR *Filename)=0

virtual bool	DeleteFile (const TCHAR *Filename)=0

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

virtual bool	IsReadOnly (const TCHAR *Filename)=0

virtual bool	MoveFile (const TCHAR To, const TCHAR From)=0

virtual bool	SetReadOnly (const TCHAR *Filename, bool bNewReadOnlyValue)=0

virtual FDateTime	GetTimeStamp (const TCHAR *Filename)=0

virtual void	SetTimeStamp (const TCHAR *Filename, FDateTime DateTime)=0

virtual FDateTime	GetAccessTimeStamp (const TCHAR *Filename)=0

virtual FString	GetFilenameOnDisk (const TCHAR *Filename)=0

virtual ESymlinkResult	IsSymlink (const TCHAR *Filename)

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 IFileHandle *	OpenRead (const TCHAR *Filename, bool bAllowWrite=false)=0

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

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

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

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

virtual bool	DirectoryExists (const TCHAR *Directory)=0

virtual bool	CreateDirectory (const TCHAR *Directory)=0

virtual bool	DeleteDirectory (const TCHAR *Directory)=0

virtual FFileStatData	GetStatData (const TCHAR *FilenameOrDirectory)=0

virtual bool	IterateDirectory (const TCHAR *Directory, FDirectoryVisitor &Visitor)=0

virtual bool	IterateDirectoryStat (const TCHAR *Directory, FDirectoryStatVisitor &Visitor)=0

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 FOpenMappedResult	OpenMappedEx (const TCHAR *Filename, EOpenReadFlags OpenOptions=EOpenReadFlags::None, int64 MaximumSize=0)

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	CopyFile (const TCHAR To, const TCHAR From, EPlatformFileRead ReadFlags=EPlatformFileRead::None, EPlatformFileWrite WriteFlags=EPlatformFileWrite::None)

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)

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

Common base for physical platform File I/O Interface

Member Function Documentation

◆ GetLowerLevel()

virtual IPlatformFile * IPhysicalPlatformFile::GetLowerLevel ( )

inlineoverridevirtual

Gets the platform file wrapped by this file.

Implements IPlatformFile.

◆ GetName()

virtual const TCHAR * IPhysicalPlatformFile::GetName ( ) const

inlineoverridevirtual

Gets this platform file type name.

Implements IPlatformFile.

◆ Initialize()

bool IPhysicalPlatformFile::Initialize	(	IPlatformFile *	Inner,
		const TCHAR *	CmdLine
	)

overridevirtual

Initializes platform file.

Parameters

Inner	Platform file to wrap by this file.
CmdLine	Command line to parse.

Returns: true if the initialization was successful, false otherise.

Implements IPlatformFile.

◆ SetLowerLevel()

virtual void IPhysicalPlatformFile::SetLowerLevel ( IPlatformFile * NewLowerLevel )

inlineoverridevirtual

Sets the platform file wrapped by this file.

Implements IPlatformFile.

◆ ShouldBeUsed()

virtual bool IPhysicalPlatformFile::ShouldBeUsed	(	IPlatformFile *	Inner,
		const TCHAR *	CmdLine
	)		const

inlineoverridevirtual

Checks if this platform file should be used even though it was not asked to be. i.e. pak files exist on disk so we should use a pak file

Reimplemented from IPlatformFile.

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

Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformFile.h
Engine/Source/Runtime/Core/Private/GenericPlatform/GenericPlatformFile.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetLowerLevel()

◆ GetName()

◆ Initialize()

◆ SetLowerLevel()

◆ ShouldBeUsed()