FCbValue | Unreal Engine 5.7 Documentation

A type that provides unchecked access to compact binary values.

The main purpose of the type is to efficiently switch on field type. For every other use case, prefer to use the field, array, and object types directly. The accessors here do not check the type before reading the value, which means they can read out of bounds even on a valid compact binary value if the wrong accessor is used.


Name	FCbValue
Type	class
Header File	/Engine/Source/Runtime/Core/Public/Serialization/CompactBinaryValue.h
Include Path	#include "Serialization/CompactBinaryValue.h"

Syntax

class FCbValue

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FCbValue ( ECbFieldType Type, const void* Value )		Serialization/CompactBinaryValue.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
Data	const void *		Serialization/CompactBinaryValue.h
Type	ECbFieldType		Serialization/CompactBinaryValue.h

Functions

Public

Name	Remarks	Include Path
FCbArrayView AsArrayView()		Serialization/CompactBinaryValue.h
FIoHash AsAttachment()		Serialization/CompactBinaryValue.h
FMemoryView AsBinary()		Serialization/CompactBinaryValue.h
FIoHash AsBinaryAttachment()		Serialization/CompactBinaryValue.h
bool AsBool()		Serialization/CompactBinaryValue.h
FCbCustomById AsCustomById()		Serialization/CompactBinaryValue.h
FCbCustomByName AsCustomByName()		Serialization/CompactBinaryValue.h
int64 AsDateTimeTicks()		Serialization/CompactBinaryValue.h
float AsFloat32()		Serialization/CompactBinaryValue.h
double AsFloat64()		Serialization/CompactBinaryValue.h
FIoHash AsHash()		Serialization/CompactBinaryValue.h
uint64 AsInteger ( UE::CompactBinary::Private::FIntegerParams Params, ECbFieldError* OutError, uint64 Default ) const	Access as an integer, with both positive and negative values returned as unsigned.	Serialization/CompactBinaryValue.h
int64 AsIntegerNegative()		Serialization/CompactBinaryValue.h
uint64 AsIntegerPositive()		Serialization/CompactBinaryValue.h
FIoHash AsObjectAttachment()		Serialization/CompactBinaryValue.h
FCbObjectId AsObjectId()		Serialization/CompactBinaryValue.h
FCbObjectView AsObjectView()		Serialization/CompactBinaryValue.h
FUtf8StringView AsString ( ECbFieldError* OutError, FUtf8StringView Default ) const	Access as a string. Checks for range errors and uses the default if OutError is not null.	Serialization/CompactBinaryValue.h
int64 AsTimeSpanTicks()		Serialization/CompactBinaryValue.h
FGuid AsUuid()		Serialization/CompactBinaryValue.h
const void * GetData()		Serialization/CompactBinaryValue.h
ECbFieldType GetType()		Serialization/CompactBinaryValue.h