FValue

A value is a compressed buffer identified by its raw hash and raw size.

Windows
MacOS
Linux

Inheritance Hierarchy

FValue

FValueWithId

References

Module

DerivedDataCache

Header

/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataValue.h

Include

#include "DerivedDataValue.h"

Syntax

class FValue

Remarks

A value is a compressed buffer identified by its raw hash and raw size.

A value without data may be used as a reference to the value.

Constructors

Name Description

Public function

FValue()

Construct a null value, which is a hash and size of zero with no data.

Public function

FValue

(
    const FCompressedBuffer& Data
)

Construct a value from a compressed buffer, which is cloned if not owned.

Public function

FValue

(
    FCompressedBuffer&& Data
)

Construct a null value, which is a hash and size of zero with no data.

Public function

FValue

(
    const FIoHash& RawHash,
    uint64 RawSize
)

Construct a value reference from the hash and size of its data.

Functions

Name Description

Public function Static

FValue

 

Compress

(
    const FCompositeBuffer& RawData,
    uint64 BlockSize
)

Compress the buffer to a value using default derived data compression parameters.

Public function Static

FValue

 

Compress

(
    const FSharedBuffer& RawData,
    uint64 BlockSize
)

Compress the buffer to a value using default derived data compression parameters.

Public function Const

const FCompr...

 

GetData()

Returns the compressed buffer for the value. May be null.

Public function Const

const FIoHas...

 

GetRawHash()

Returns the hash of the raw buffer (uncompressed) for the value.

Public function Const

uint64

 

GetRawSize()

Returns the size of the raw buffer (uncompressed) for the value.

Public function Const

bool

 

HasData()

Whether the compressed buffer for the value is available.

Public function Const

FValue

 

RemoveData()

Create a copy of the value with the data removed.

Public function

void

 

Reset()

Reset this to null.

Constants

Name

Description

Null

A null value.