FArchiveFileReaderGeneric

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/HAL/FileManagerGeneric.h

Include

#include "HAL/FileManagerGeneric.h"

Syntax

class FArchiveFileReaderGeneric : public FArchive

Variables

Name Description

Protected variable

bool

 

bFirstReadAfterSeek

Protected variable

TArray64< uint8...

 

BufferArray

The contract for the BufferWindow and the low level pos is that if we have a BufferWindow and Pos is within it, then the LowLevel Pos is at the end of the BufferWindow If we do not have a BufferWindow, or Pos is outside of it, then LowLevel Pos is at Pos.

Protected variable

int64

 

BufferBase

Protected variable

int64

 

BufferSize

Protected variable

FString

 

Filename

Filename for debugging purposes.

Protected variable

uint32

 

Flags

Protected variable

TUniquePtr< IFi...

 

Handle

Protected variable

int64

 

Pos

Protected variable

int64

 

Size

Constructors

Name Description

Public function

FArchiveFileReaderGeneric

(
    IFileHandle* InHandle,
    const TCHAR* InFilename,
    int64 InSize,
    uint32 InBufferSize,
    uint32 InFlags
)

Destructors

Name Description

Public function

~FArchiveFileReaderGeneric()

Functions

Name Description

Protected function Virtual

void

 

CloseLowLevel()

Close the file handle

Protected function

bool

 

InternalPrecache

(
    int64 PrecacheOffset,
    int64 PrecacheSize
)

Protected function Const

bool

 

IsSilent()

Returns true if the archive should suppress logging in case of error

Protected function Virtual

void

 

ReadLowLevel

(
    uint8* Dest,
    int64 CountToRead,
    int64& OutBytesRead
)

Platform specific read

Protected function Virtual

bool

 

SeekLowLevel

(
    int64 InPos
)

Platform specific seek

Overridden from FArchive

Name Description

Public function Virtual

bool

 

Close()

Attempts to close and finalize any handles used for backing data storage, returns true if it succeeded.

Public function Virtual

void

 

FlushCache()

Flushes cache and frees internal data.

Public function Virtual

bool

 

Precache

(
    int64 PrecacheOffset,
    int64 PrecacheSize
)

Hint the archive that the region starting at passed in offset and spanning the passed in size is going to be read soon and should be precached.

Public function Virtual

void

 

Seek

(
    int64 InPos
)

Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.

Public function Virtual

void

 

Serialize

(
    void* V,
    int64 Length
)

Overridden from FArchiveState

Name Description

Public function Virtual Const

FString

 

GetArchiveName()

Returns the name of the Archive.

Public function Virtual

int64

 

Tell()

Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location.

Public function Virtual

int64

 

TotalSize()

Returns total size of the backing data storage.

Constants

Name

Description

bPrecacheAsSoonAsPossible