#include <GenericPlatformFile.h>

Inheritance diagram for IPlatformFile::FDirectoryVisitor:

Public Member Functions
	FDirectoryVisitor (EDirectoryVisitorFlags InDirectoryVisitorFlags=EDirectoryVisitorFlags::None)

virtual	~FDirectoryVisitor ()

virtual bool	ShouldVisitLeafPathname (FStringView LeafPathname)

virtual bool	Visit (const TCHAR *FilenameOrDirectory, bool bIsDirectory)=0

CORE_API bool	CallShouldVisitAndVisit (const TCHAR *FilenameOrDirectory, bool bIsDirectory)

UE_FORCEINLINE_HINT bool	IsThreadSafe () const

Public Attributes
EDirectoryVisitorFlags	DirectoryVisitorFlags

Detailed Description

Base class for file and directory visitors that take only the name.

Constructor & Destructor Documentation

◆ FDirectoryVisitor()

IPlatformFile::FDirectoryVisitor::FDirectoryVisitor ( EDirectoryVisitorFlags InDirectoryVisitorFlags = EDirectoryVisitorFlags::None )

inline

◆ ~FDirectoryVisitor()

virtual IPlatformFile::FDirectoryVisitor::~FDirectoryVisitor ( )

inlinevirtual

Member Function Documentation

◆ CallShouldVisitAndVisit()

bool IPlatformFile::FDirectoryVisitor::CallShouldVisitAndVisit	(	const TCHAR *	FilenameOrDirectory,
		bool	bIsDirectory
	)

Helper function for receivers of FDirectoryVisitor. Enforces the contract for whether Visit should be called after calling ShouldVisitLeafPathName.

◆ IsThreadSafe()

UE_FORCEINLINE_HINT bool IPlatformFile::FDirectoryVisitor::IsThreadSafe ( ) const

inline

True if the Visit function can be called from multiple threads at once.

◆ ShouldVisitLeafPathname()

virtual bool IPlatformFile::FDirectoryVisitor::ShouldVisitLeafPathname ( FStringView LeafPathname )

inlinevirtual

Called with the LeafPathname (FullPath == Path/LeafPathname, LeafPathname == BaseName.Extension) before calling Visit. If it returns true, Visit will be called on the path, otherwise Visit will be skipped, and the return value of Visit is treated as true (continue iterating). Called both for directories and files.

Reimplemented in FileManagerGenericImpl::FFileMatch.

◆ Visit()

virtual bool IPlatformFile::FDirectoryVisitor::Visit	(	const TCHAR *	FilenameOrDirectory,
		bool	bIsDirectory
	)

pure virtual

Callback for a single file or a directory in a directory iteration.

Parameters

FilenameOrDirectory	If bIsDirectory is true, this is a directory (with no trailing path delimiter), otherwise it is a file name.
bIsDirectory	true if FilenameOrDirectory is a directory.

Returns: true if the iteration should continue.

Implemented in FileManagerGenericImpl::FFileMatch, FLocalTimestampDirectoryVisitor, UE::PakFile::Private::FPreventDuplicatesVisitor, FPakFileSearchVisitor, FDirectoryVisitorFuncWrapper, FFindFilesVisitor, FLoggedPlatformFile::FLogVisitor, FunctorDirectoryVisitor< FunctorType >, FWorldTilesGatherer, BuildPatchServices::FParallelDirectoryEnumerator, and FSandboxVisitor.

Member Data Documentation

◆ DirectoryVisitorFlags

EDirectoryVisitorFlags IPlatformFile::FDirectoryVisitor::DirectoryVisitorFlags

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

Public Attributes