FCbObjectId Class Reference

#include <CompactBinary.h>

Public Types
using	ByteArray = uint8[12]

Public Member Functions
	FCbObjectId ()=default
	FCbObjectId (const ByteArray &ObjectId)
CORE_API	FCbObjectId (FMemoryView ObjectId)
const ByteArray &	GetBytes () const
	operator const ByteArray & () const
constexpr FMemoryView	GetView () const
bool	operator== (const FCbObjectId &B) const
bool	operator!= (const FCbObjectId &B) const
bool	operator< (const FCbObjectId &B) const

Static Public Member Functions
static CORE_API FCbObjectId	NewObjectId ()

Friends
uint32	GetTypeHash (const FCbObjectId &Id)
template<typename CharType >
TStringBuilderBase< CharType > &	operator<< (TStringBuilderBase< CharType > &Builder, const FCbObjectId &Id)

Detailed Description

An opaque 12-byte object identifier.

It has no intrinsic meaning, and can only be properly interpreted in the context of its usage.

Member Typedef Documentation

ByteArray

using FCbObjectId::ByteArray = uint8[12]

Constructor & Destructor Documentation

FCbObjectId() [1/3]

FCbObjectId::FCbObjectId ( )

default

Construct an ObjectId with every byte initialized to zero.

FCbObjectId() [2/3]

FCbObjectId::FCbObjectId ( const ByteArray &  ObjectId )

inlineexplicit

Construct an ObjectId from an array of 12 bytes.

FCbObjectId() [3/3]

FCbObjectId::FCbObjectId ( FMemoryView  ObjectId )

explicit

Construct an ObjectId from a view of 12 bytes.

Member Function Documentation

GetBytes()

const ByteArray & FCbObjectId::GetBytes ( ) const

inline

Returns a reference to the raw byte array for the ObjectId.

GetView()

constexpr FMemoryView FCbObjectId::GetView ( ) const

inlineconstexpr

Returns a view of the raw byte array for the ObjectId.

NewObjectId()

FCbObjectId FCbObjectId::NewObjectId ( )

static

operator const ByteArray &()

FCbObjectId::operator const ByteArray & ( ) const

inline

operator!=()

bool FCbObjectId::operator!= ( const FCbObjectId &  B ) const

inline

operator<()

bool FCbObjectId::operator< ( const FCbObjectId &  B ) const

inline

operator==()

bool FCbObjectId::operator== ( const FCbObjectId &  B ) const

inline

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FCbObjectId &  Id )

friend

operator<<

template<typename CharType >

TStringBuilderBase< CharType > & operator<< ( TStringBuilderBase< CharType > &  Builder, const FCbObjectId &  Id  )

friend

Convert the ObjectId to a 24-character hex string.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Core/Public/Serialization/CompactBinary.h
• Engine/Source/Runtime/Core/Private/Serialization/CompactBinary.cpp