Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FCbObjectId Class Reference

#include <CompactBinary.h>

Public Types

using ByteArray = uint8[12]
 

Public Member Functions

 FCbObjectId ()=default
 
 FCbObjectId (const ByteArray &ObjectId)
 
 FCbObjectId (FMemoryView ObjectId)
 
const ByteArrayGetBytes () 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 FCbObjectId NewObjectId ()
 

Private Attributes

ByteArray Bytes {}
 

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.

Definition at line 478 of file CompactBinary.h.

Member Typedef Documentation

◆ ByteArray

Definition at line 481 of file CompactBinary.h.

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.

Definition at line 533 of file CompactBinary.h.

+ Here is the call graph for this function:

◆ 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.

Definition at line 493 of file CompactBinary.h.

◆ GetView()

constexpr FMemoryView FCbObjectId::GetView ( ) const
inlineconstexpr

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

Definition at line 497 of file CompactBinary.h.

◆ NewObjectId()

static FCbObjectId FCbObjectId::NewObjectId ( )
static

◆ operator const ByteArray &()

FCbObjectId::operator const ByteArray & ( ) const
inline

Definition at line 494 of file CompactBinary.h.

◆ operator!=()

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

Definition at line 506 of file CompactBinary.h.

+ Here is the call graph for this function:

◆ operator<()

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

Definition at line 511 of file CompactBinary.h.

+ Here is the call graph for this function:

◆ operator==()

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

Definition at line 501 of file CompactBinary.h.

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FCbObjectId & Id)
friend

Definition at line 516 of file CompactBinary.h.

◆ operator<<

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

Convert the ObjectId to a 24-character hex string.

Definition at line 523 of file CompactBinary.h.

Member Data Documentation

◆ Bytes

ByteArray FCbObjectId::Bytes {}
private

Definition at line 530 of file CompactBinary.h.


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