FBufferReaderBase

Similar to [FMemoryReader](API\Runtime\Core\Serialization\FMemoryReader), but able to internally manage the memory for the buffer.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Serialization/BufferReader.h

Include

#include "Serialization/BufferReader.h"

Syntax

class FBufferReaderBase : public FArchive

Remarks

Similar to FMemoryReader, but able to internally manage the memory for the buffer.

Variables

Name Description

Protected variable

bool

 

bFreeOnClose

Protected variable

void *

 

ReaderData

Protected variable

int64

 

ReaderPos

Protected variable

int64

 

ReaderSize

Constructors

Name Description

Public function

FBufferReaderBase

(
    void* Data,
    int64 Size,
    bool bInFreeOnClose,
    bool bIsPersistent
)

Constructor

Destructors

Name Description

Public function

~FBufferReaderBase()

Abstract to force implementors to call Close() themselves, since it's a virtual function.

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

 

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* Data,
    int64 Num
)

Overridden from FArchiveState

Name Description

Public function Virtual

bool

 

AtEnd()

Returns true if the current location within the backing data storage is at the end, always returns false if there is no storage.

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.