FLoggedFileHandle Class Reference

#include <IPlatformFileLogWrapper.h>

Inheritance diagram for FLoggedFileHandle:

Collaboration diagram for FLoggedFileHandle:

Public Member Functions
	FLoggedFileHandle (IFileHandle *InFileHandle, const TCHAR *InFilename, FLoggedPlatformFile &InOwner)
virtual	~FLoggedFileHandle ()
virtual int64	Tell () override
virtual bool	Seek (int64 NewPosition) override
virtual bool	SeekFromEnd (int64 NewPositionRelativeToEnd) override
virtual bool	Read (uint8 *Destination, int64 BytesToRead) override
virtual bool	Write (const uint8 *Source, int64 BytesToWrite) override
virtual int64	Size () override
virtual bool	Flush (const bool bFullFlush=false) override
virtual bool	Truncate (int64 NewSize) override
virtual void	ShrinkBuffers () override
Public Member Functions inherited from IFileHandle
virtual	~IFileHandle ()

Private Attributes
TUniquePtr< IFileHandle >	FileHandle
FString	Filename
FLoggedPlatformFile &	PlatformFile

Detailed Description

Definition at line 42 of file IPlatformFileLogWrapper.h.

Constructor & Destructor Documentation

FLoggedFileHandle()

FLoggedFileHandle::FLoggedFileHandle	(	IFileHandle *	InFileHandle,
		const TCHAR *	InFilename,
		FLoggedPlatformFile &	InOwner )

Here is the caller graph for this function:

~FLoggedFileHandle()

virtual FLoggedFileHandle::~FLoggedFileHandle ( )

virtual

Member Function Documentation

Flush()

virtual bool FLoggedFileHandle::Flush ( const bool bFullFlush = false )

inlineoverridevirtual

Flushes file handle to disk.

Parameters

bFullFlush

true to flush everything about the file (including its meta-data) with a strong guarantee that it will be on disk by the time this function returns, or false to let the operating/file system have more leeway about when the data actually gets written to disk

Returns

true if operation completed successfully.

Implements IFileHandle.

Definition at line 108 of file IPlatformFileLogWrapper.h.

Here is the call graph for this function:

Read()

virtual bool FLoggedFileHandle::Read ( uint8 * Destination, int64 BytesToRead )

inlineoverridevirtual

Read bytes from the file.

Parameters

Destination	Buffer to holds the results, should be at least BytesToRead in size.
BytesToRead	Number of bytes to read into the destination.

Returns

true if the operation completed successfully.

Implements IFileHandle.

Definition at line 81 of file IPlatformFileLogWrapper.h.

Here is the call graph for this function:

Seek()

virtual bool FLoggedFileHandle::Seek ( int64 NewPosition )

inlineoverridevirtual

Change the current write or read position.

Parameters

NewPosition

new write or read position

Returns

true if the operation completed successfully.

Implements IFileHandle.

Definition at line 63 of file IPlatformFileLogWrapper.h.

Here is the call graph for this function:

SeekFromEnd()

virtual bool FLoggedFileHandle::SeekFromEnd ( int64 NewPositionRelativeToEnd )

inlineoverridevirtual

Change the current write or read position, relative to the end of the file.

Parameters

NewPositionRelativeToEnd

new write or read position, relative to the end of the file should be <=0!

Returns

true if the operation completed successfully.

Implements IFileHandle.

Definition at line 72 of file IPlatformFileLogWrapper.h.

Here is the call graph for this function:

ShrinkBuffers()

virtual void FLoggedFileHandle::ShrinkBuffers ( )

inlineoverridevirtual

Minimizes optional system or process cache kept for the file.

Reimplemented from IFileHandle.

Definition at line 126 of file IPlatformFileLogWrapper.h.

Here is the call graph for this function:

Size()

virtual int64 FLoggedFileHandle::Size ( )

inlineoverridevirtual

Return the total size of the file

Reimplemented from IFileHandle.

Definition at line 99 of file IPlatformFileLogWrapper.h.

Here is the call graph for this function:

Tell()

virtual int64 FLoggedFileHandle::Tell ( )

inlineoverridevirtual

Return the current write or read position.

Implements IFileHandle.

Definition at line 54 of file IPlatformFileLogWrapper.h.

Here is the call graph for this function:

Truncate()

virtual bool FLoggedFileHandle::Truncate ( int64 NewSize )

inlineoverridevirtual

Truncate the file to the given size (in bytes).

Parameters

NewSize

Truncated file size (in bytes).

Returns

true if the operation completed successfully.

Implements IFileHandle.

Definition at line 117 of file IPlatformFileLogWrapper.h.

Here is the call graph for this function:

Write()

virtual bool FLoggedFileHandle::Write ( const uint8 * Source, int64 BytesToWrite )

inlineoverridevirtual

Write bytes to the file.

Parameters

Source	Buffer to write, should be at least BytesToWrite in size.
BytesToWrite	Number of bytes to write.

Returns

true if the operation completed successfully.

Implements IFileHandle.

Definition at line 90 of file IPlatformFileLogWrapper.h.

Here is the call graph for this function:

Member Data Documentation

FileHandle

TUniquePtr<IFileHandle> FLoggedFileHandle::FileHandle

private

Definition at line 44 of file IPlatformFileLogWrapper.h.

Filename

FString FLoggedFileHandle::Filename

private

Definition at line 45 of file IPlatformFileLogWrapper.h.

PlatformFile

FLoggedPlatformFile& FLoggedFileHandle::PlatformFile

private

Definition at line 47 of file IPlatformFileLogWrapper.h.

---

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

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/HAL/IPlatformFileLogWrapper.h