FManagedStorageFileWriteHandle Class Reference

#include <IPlatformFileManagedStorageWrapper.h>

Inheritance diagram for FManagedStorageFileWriteHandle:

Collaboration diagram for FManagedStorageFileWriteHandle:

Public Member Functions
	FManagedStorageFileWriteHandle (IFileHandle *InFileHandle, FPersistentManagedFile InFile)
virtual	~FManagedStorageFileWriteHandle ()
virtual int64	Tell () override
virtual bool	Seek (int64 NewPosition) override
virtual bool	SeekFromEnd (int64 NewPositionRelativeToEnd=0) 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 Member Functions
bool	TryManageFile ()

Static Private Member Functions
static bool	IsReady ()

Private Attributes
TUniquePtr< IFileHandle >	FileHandle
FPersistentManagedFile	File

Detailed Description

Definition at line 658 of file IPlatformFileManagedStorageWrapper.h.

Constructor & Destructor Documentation

FManagedStorageFileWriteHandle()

FManagedStorageFileWriteHandle::FManagedStorageFileWriteHandle ( IFileHandle * InFileHandle, FPersistentManagedFile InFile )

inline

Definition at line 678 of file IPlatformFileManagedStorageWrapper.h.

Here is the call graph for this function:

Here is the caller graph for this function:

~FManagedStorageFileWriteHandle()

virtual FManagedStorageFileWriteHandle::~FManagedStorageFileWriteHandle ( )

inlinevirtual

Definition at line 684 of file IPlatformFileManagedStorageWrapper.h.

Here is the call graph for this function:

Member Function Documentation

Flush()

virtual bool FManagedStorageFileWriteHandle::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 755 of file IPlatformFileManagedStorageWrapper.h.

Here is the call graph for this function:

IsReady()

static bool FManagedStorageFileWriteHandle::IsReady ( )

inlinestaticprivate

Definition at line 661 of file IPlatformFileManagedStorageWrapper.h.

Here is the call graph for this function:

Read()

virtual bool FManagedStorageFileWriteHandle::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 711 of file IPlatformFileManagedStorageWrapper.h.

Seek()

virtual bool FManagedStorageFileWriteHandle::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 701 of file IPlatformFileManagedStorageWrapper.h.

SeekFromEnd()

virtual bool FManagedStorageFileWriteHandle::SeekFromEnd ( int64 NewPositionRelativeToEnd = 0 )

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 706 of file IPlatformFileManagedStorageWrapper.h.

ShrinkBuffers()

virtual void FManagedStorageFileWriteHandle::ShrinkBuffers ( )

inlineoverridevirtual

Minimizes optional system or process cache kept for the file.

Reimplemented from IFileHandle.

Definition at line 816 of file IPlatformFileManagedStorageWrapper.h.

Size()

virtual int64 FManagedStorageFileWriteHandle::Size ( )

inlineoverridevirtual

Return the total size of the file

Reimplemented from IFileHandle.

Definition at line 750 of file IPlatformFileManagedStorageWrapper.h.

Tell()

virtual int64 FManagedStorageFileWriteHandle::Tell ( )

inlineoverridevirtual

Return the current write or read position.

Implements IFileHandle.

Definition at line 696 of file IPlatformFileManagedStorageWrapper.h.

Truncate()

virtual bool FManagedStorageFileWriteHandle::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 779 of file IPlatformFileManagedStorageWrapper.h.

Here is the call graph for this function:

TryManageFile()

bool FManagedStorageFileWriteHandle::TryManageFile ( )

inlineprivate

Definition at line 667 of file IPlatformFileManagedStorageWrapper.h.

Here is the caller graph for this function:

Write()

virtual bool FManagedStorageFileWriteHandle::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 716 of file IPlatformFileManagedStorageWrapper.h.

Here is the call graph for this function:

Member Data Documentation

File

FPersistentManagedFile FManagedStorageFileWriteHandle::File

private

Definition at line 823 of file IPlatformFileManagedStorageWrapper.h.

FileHandle

TUniquePtr<IFileHandle> FManagedStorageFileWriteHandle::FileHandle

private

Definition at line 822 of file IPlatformFileManagedStorageWrapper.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/IPlatformFileManagedStorageWrapper.h