#include <AndroidPlatformFile.h>

Inheritance diagram for IAndroidPlatformFile:

Public Member Functions
virtual bool	FileExists (const TCHAR *Filename, bool bAllowAssets)=0

virtual int64	FileSize (const TCHAR *Filename, bool bAllowAssets)=0

virtual FFileStatData	GetStatData (const TCHAR *FilenameOrDirectory, bool bAllowAssets)=0

virtual bool	DirectoryExists (const TCHAR *Directory, bool bAllowAssets)=0

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

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

virtual bool	IsAsset (const TCHAR *Filename)=0

virtual int64	FileStartOffset (const TCHAR *Filename)=0

virtual FString	FileRootPath (const TCHAR *Filename)=0

virtual CORE_API FString	ConvertToAbsolutePathForExternalAppForRead (const TCHAR *Filename) override

virtual CORE_API FString	ConvertToAbsolutePathForExternalAppForWrite (const TCHAR *Filename) override

virtual bool	FileExists (const TCHAR *Filename)=0

virtual int64	FileSize (const TCHAR *Filename)=0

virtual FFileStatData	GetStatData (const TCHAR *FilenameOrDirectory)=0

virtual bool	DirectoryExists (const TCHAR *Directory)=0

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

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

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

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

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	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	CreateDirectory (const TCHAR *Directory)=0

virtual bool	DeleteDirectory (const TCHAR *Directory)=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	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 bool	SendMessageToServer (const TCHAR Message, IFileServerMessageHandler Handler)

virtual bool	DoesCreatePublicFiles ()

virtual void	SetCreatePublicFiles (bool bCreatePublicFiles)

virtual int64	GetAllowedBytesToWriteThrottledStorage (const TCHAR *DestinationPath=nullptr)

Static Public Member Functions
static CORE_API IAndroidPlatformFile &	GetPlatformPhysical ()

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

static CORE_API const TCHAR *	GetPhysicalTypeName ()

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

Detailed Description

Android File I/O implementation with additional utilities to deal with Java side access.

Member Function Documentation

◆ ConvertToAbsolutePathForExternalAppForRead()

virtual CORE_API FString IAndroidPlatformFile::ConvertToAbsolutePathForExternalAppForRead ( const TCHAR * Filename )

overridevirtual

Converts passed in filename to use an absolute path (for reading).

Parameters

Filename filename to convert to use an absolute path, safe to pass in already using absolute path

Returns: filename using absolute path

Reimplemented from IPlatformFile.

◆ ConvertToAbsolutePathForExternalAppForWrite()

virtual CORE_API FString IAndroidPlatformFile::ConvertToAbsolutePathForExternalAppForWrite ( const TCHAR * Filename )

overridevirtual

Converts passed in filename to use an absolute path (for writing)

Parameters

Filename filename to convert to use an absolute path, safe to pass in already using absolute path

Returns: filename using absolute path

Reimplemented from IPlatformFile.

◆ DirectoryExists() [1/2]

virtual bool IPlatformFile::DirectoryExists ( const TCHAR * Directory )

virtual

Return true if the directory exists.

Implements IPlatformFile.

◆ DirectoryExists() [2/2]

virtual bool IAndroidPlatformFile::DirectoryExists	(	const TCHAR *	Directory,
		bool	bAllowAssets
	)

pure virtual

◆ FileExists() [1/2]

virtual bool IPlatformFile::FileExists ( const TCHAR * Filename )

virtual

Return true if the file exists.

Implements IPlatformFile.

◆ FileExists() [2/2]

virtual bool IAndroidPlatformFile::FileExists	(	const TCHAR *	Filename,
		bool	bAllowAssets
	)

pure virtual

◆ FileRootPath()

virtual FString IAndroidPlatformFile::FileRootPath ( const TCHAR * Filename )

pure virtual

◆ FileSize() [1/2]

virtual int64 IPlatformFile::FileSize ( const TCHAR * Filename )

virtual

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

Implements IPlatformFile.

◆ FileSize() [2/2]

virtual int64 IAndroidPlatformFile::FileSize	(	const TCHAR *	Filename,
		bool	bAllowAssets
	)

pure virtual

◆ FileStartOffset()

virtual int64 IAndroidPlatformFile::FileStartOffset ( const TCHAR * Filename )

pure virtual

◆ GetPlatformPhysical()

static CORE_API IAndroidPlatformFile & IAndroidPlatformFile::GetPlatformPhysical ( )

static

◆ GetStatData() [1/2]

virtual FFileStatData IPlatformFile::GetStatData ( const TCHAR * FilenameOrDirectory )

virtual

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

Implements IPlatformFile.

◆ GetStatData() [2/2]

virtual FFileStatData IAndroidPlatformFile::GetStatData	(	const TCHAR *	FilenameOrDirectory,
		bool	bAllowAssets
	)

pure virtual

◆ IsAsset()

virtual bool IAndroidPlatformFile::IsAsset ( const TCHAR * Filename )

pure virtual

◆ IterateDirectory() [1/3]

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

virtual

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.

◆ IterateDirectory() [2/3]

virtual bool IAndroidPlatformFile::IterateDirectory	(	const TCHAR *	Directory,
		FDirectoryVisitor &	Visitor,
		bool	bAllowAssets
	)

pure virtual

◆ IterateDirectory() [3/3]

bool IPlatformFile::IterateDirectory	(	const TCHAR *	Directory,
		FDirectoryVisitorFunc	Visitor
	)

virtual

Call 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 (see FDirectoryVisitor::Visit for the signature)

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

Reimplemented from IPlatformFile.

◆ IterateDirectoryStat() [1/3]

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

virtual

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.

◆ IterateDirectoryStat() [2/3]

virtual bool IAndroidPlatformFile::IterateDirectoryStat	(	const TCHAR *	Directory,
		FDirectoryStatVisitor &	Visitor,
		bool	bAllowAssets
	)

pure virtual

◆ IterateDirectoryStat() [3/3]

bool IPlatformFile::IterateDirectoryStat	(	const TCHAR *	Directory,
		FDirectoryStatVisitorFunc	Visitor
	)

virtual

Call 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 (see FDirectoryStatVisitor::Visit for the signature)

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

Reimplemented from IPlatformFile.

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

Engine/Source/Runtime/Core/Public/Android/AndroidPlatformFile.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ConvertToAbsolutePathForExternalAppForRead()

◆ ConvertToAbsolutePathForExternalAppForWrite()

◆ DirectoryExists() [1/2]

◆ DirectoryExists() [2/2]

◆ FileExists() [1/2]

◆ FileExists() [2/2]

◆ FileRootPath()

◆ FileSize() [1/2]

◆ FileSize() [2/2]

◆ FileStartOffset()

◆ GetPlatformPhysical()

◆ GetStatData() [1/2]

◆ GetStatData() [2/2]

◆ IsAsset()

◆ IterateDirectory() [1/3]

◆ IterateDirectory() [2/3]

◆ IterateDirectory() [3/3]

◆ IterateDirectoryStat() [1/3]

◆ IterateDirectoryStat() [2/3]

◆ IterateDirectoryStat() [3/3]