#include <CompactBinary.h>

Inheritance diagram for FCbObject:

Public Member Functions
FCbField	Find (FUtf8StringView Name) const

FCbField	FindIgnoreCase (FUtf8StringView Name) const

FCbField	operator[] (FUtf8StringView Name) const

FCbField	AsField () const &

FCbField	AsField () &&

CORE_API FCompositeBuffer	GetBuffer () const

	TCbBuffer ()=default

	TCbBuffer (FSharedBuffer ValueBuffer, ECbFieldType Type=ECbFieldType::HasFieldType)

	TCbBuffer (const ViewType &Value, FSharedBuffer OuterBuffer)

template<typename OtherViewType >
	TCbBuffer (const ViewType &Value, TCbBuffer< OtherViewType > OuterBuffer)

Public Member Functions inherited from TCbBuffer< FCbObjectView >
	TCbBuffer ()=default

	TCbBuffer (FSharedBuffer ValueBuffer, ECbFieldType Type=ECbFieldType::HasFieldType)

	TCbBuffer (const FCbObjectView &Value, FSharedBuffer OuterBuffer)

	TCbBuffer (const FCbObjectView &Value, TCbBuffer< OtherViewType > OuterBuffer)

void	Reset ()

bool	IsOwned () const

void	MakeOwned ()

const FCbObjectView &	AsView () const

const FSharedBuffer &	GetOuterBuffer () const &

FSharedBuffer	GetOuterBuffer () &&

FCbField	operator[] (FUtf8StringView Name) const

FCbFieldIterator	CreateIterator () const

FCbFieldIterator	begin () const

constexpr FCbIteratorSentinel	end () const

Public Member Functions inherited from FCbObjectView
CORE_API	FCbObjectView ()

CORE_API FCbFieldView	FindView (FUtf8StringView Name) const

CORE_API FCbFieldView	FindViewIgnoreCase (FUtf8StringView Name) const

FCbFieldView	operator[] (FUtf8StringView Name) const

FCbFieldView	AsFieldView () const

CORE_API	operator bool () const

CORE_API uint64	GetSize () const

CORE_API FIoHash	GetHash () const

CORE_API void	AppendHash (FIoHashBuilder &Builder) const

CORE_API bool	Equals (const FCbObjectView &Other) const

CORE_API void	CopyTo (FMutableMemoryView Buffer) const

CORE_API void	CopyTo (FArchive &Ar) const

void	IterateAttachments (FCbFieldVisitor Visitor) const

bool	TryGetView (FMemoryView &OutView) const

constexpr	FCbFieldView ()=default

CORE_API	FCbFieldView (const void *Data, ECbFieldType Type=ECbFieldType::HasFieldType)

	FCbFieldView (const FCbValue &Value)

CORE_API FCbFieldViewIterator	CreateViewIterator () const

FCbFieldViewIterator	begin () const

constexpr FCbIteratorSentinel	end () const

Additional Inherited Members
Static Public Member Functions inherited from FCbObjectView
static FCbObjectView	FromFieldNoCheck (const FCbFieldView &Field)

Static Public Member Functions inherited from TCbBufferFactory< FCbObject, FCbObjectView >
static FCbObject	Clone (const void *const Data)

static FCbObject	Clone (const FCbObjectView &Value)

static FCbObject	MakeView (const void *const Data, FSharedBuffer OuterBuffer=FSharedBuffer())

static FCbObject	MakeView (const FCbObjectView &Value, FSharedBuffer OuterBuffer=FSharedBuffer())

Protected Member Functions inherited from FCbFieldView
CORE_API FMemoryView	GetView () const

CORE_API FMemoryView	GetViewNoType () const

FMemoryView	GetValueView () const

constexpr ECbFieldType	GetType () const

constexpr ECbFieldType	GetTypeWithFlags () const

constexpr const void *	GetValueData () const

const void *	GetValueEnd () const

CORE_API uint64	GetValueSize () const

void	Assign (const void *InData, const ECbFieldType InType)

constexpr	FCbFieldView ()=default

CORE_API	FCbFieldView (const void *Data, ECbFieldType Type=ECbFieldType::HasFieldType)

	FCbFieldView (const FCbValue &Value)

constexpr FCbFieldView	RemoveName () const

constexpr FUtf8StringView	GetName () const

FCbValue	GetValue () const

CORE_API FCbObjectView	AsObjectView ()

CORE_API FCbArrayView	AsArrayView ()

CORE_API FMemoryView	AsBinaryView (FMemoryView Default=FMemoryView())

CORE_API FUtf8StringView	AsString (FUtf8StringView Default=FUtf8StringView())

int8	AsInt8 (int8 Default=0)

int16	AsInt16 (int16 Default=0)

int32	AsInt32 (int32 Default=0)

int64	AsInt64 (int64 Default=0)

uint8	AsUInt8 (uint8 Default=0)

uint16	AsUInt16 (uint16 Default=0)

uint32	AsUInt32 (uint32 Default=0)

uint64	AsUInt64 (uint64 Default=0)

CORE_API float	AsFloat (float Default=0.0f)

CORE_API double	AsDouble (double Default=0.0)

CORE_API bool	AsBool (bool bDefault=false)

CORE_API FIoHash	AsObjectAttachment (const FIoHash &Default=FIoHash())

CORE_API FIoHash	AsBinaryAttachment (const FIoHash &Default=FIoHash())

CORE_API FIoHash	AsAttachment (const FIoHash &Default=FIoHash())

CORE_API FIoHash	AsHash (const FIoHash &Default=FIoHash())

CORE_API FGuid	AsUuid ()

CORE_API FGuid	AsUuid (const FGuid &Default)

CORE_API int64	AsDateTimeTicks (int64 Default=0)

CORE_API FDateTime	AsDateTime ()

CORE_API FDateTime	AsDateTime (FDateTime Default)

CORE_API int64	AsTimeSpanTicks (int64 Default=0)

CORE_API FTimespan	AsTimeSpan ()

CORE_API FTimespan	AsTimeSpan (FTimespan Default)

CORE_API FCbObjectId	AsObjectId (const FCbObjectId &Default=FCbObjectId())

CORE_API FCbCustomById	AsCustomById (FCbCustomById Default=FCbCustomById())

CORE_API FCbCustomByName	AsCustomByName (FCbCustomByName Default=FCbCustomByName())

CORE_API FMemoryView	AsCustom (uint64 Id, FMemoryView Default=FMemoryView())

CORE_API FMemoryView	AsCustom (FUtf8StringView Name, FMemoryView Default=FMemoryView())

constexpr bool	HasName () const

constexpr bool	IsNull () const

constexpr bool	IsObject () const

constexpr bool	IsArray () const

constexpr bool	IsBinary () const

constexpr bool	IsString () const

constexpr bool	IsInteger () const

constexpr bool	IsFloat () const

constexpr bool	IsBool () const

constexpr bool	IsObjectAttachment () const

constexpr bool	IsBinaryAttachment () const

constexpr bool	IsAttachment () const

constexpr bool	IsHash () const

constexpr bool	IsUuid () const

constexpr bool	IsDateTime () const

constexpr bool	IsTimeSpan () const

constexpr bool	IsObjectId () const

constexpr bool	IsCustomById () const

constexpr bool	IsCustomByName () const

constexpr	operator bool () const

constexpr bool	HasValue () const

constexpr bool	HasError () const

constexpr ECbFieldError	GetError () const

CORE_API uint64	GetSize () const

CORE_API FIoHash	GetHash () const

CORE_API void	AppendHash (FIoHashBuilder &Builder) const

CORE_API bool	Equals (const FCbFieldView &Other) const

CORE_API void	CopyTo (FMutableMemoryView Buffer) const

CORE_API void	CopyTo (FArchive &Ar) const

CORE_API void	IterateAttachments (FCbFieldVisitor Visitor) const

bool	TryGetView (FMemoryView &OutView) const

CORE_API FCbFieldView	operator[] (FUtf8StringView Name) const

CORE_API FCbFieldViewIterator	CreateViewIterator () const

FCbFieldViewIterator	begin () const

constexpr FCbIteratorSentinel	end () const

Detailed Description

An object that includes a shared buffer for the memory that contains it.

See also: FCbObjectView; TCbBuffer

Member Function Documentation

◆ AsField() [1/2]

FCbField FCbObject::AsField ( ) &&

inline

◆ AsField() [2/2]

FCbField FCbObject::AsField ( ) const &

inline

Access the object as an object field.

◆ Find()

FCbField FCbObject::Find ( FUtf8StringView Name ) const

inline

Find a field by case-sensitive name comparison.

◆ FindIgnoreCase()

FCbField FCbObject::FindIgnoreCase ( FUtf8StringView Name ) const

inline

Find a field by case-insensitive name comparison.

◆ GetBuffer()

FCompositeBuffer FCbObject::GetBuffer ( ) const

Returns a buffer that contains the object as it would be serialized by CopyTo.

◆ operator[]()

FCbField FCbObject::operator[] ( FUtf8StringView Name ) const

inline

Find a field by case-sensitive name comparison.

◆ TCbBuffer() [1/4]

TCbBuffer< ViewType >::TCbBuffer ( )

default

Construct a default value.

◆ TCbBuffer() [2/4]

TCbBuffer< ViewType >::TCbBuffer	(	const ViewType &	Value,
		FSharedBuffer	OuterBuffer
	)

inline

Construct a value that holds a reference to the buffer that contains it.

◆ TCbBuffer() [3/4]

template<typename OtherViewType >

TCbBuffer< ViewType >::TCbBuffer	(	const ViewType &	Value,
		TCbBuffer< OtherViewType >	OuterBuffer
	)

inline

Construct a value that holds a reference to the buffer of the outer that contains it.

◆ TCbBuffer() [4/4]

TCbBuffer< ViewType >::TCbBuffer	(	FSharedBuffer	ValueBuffer,
		ECbFieldType	Type = `ECbFieldType::HasFieldType`
	)

inlineexplicit

Construct a value from a pointer to its data and an optional externally-provided type.

Parameters

ValueBuffer	A buffer that exactly contains the value.
Type	HasFieldType means that ValueBuffer contains the type. Otherwise, use the given type.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AsField() [1/2]

◆ AsField() [2/2]

◆ Find()

◆ FindIgnoreCase()

◆ GetBuffer()

◆ operator[]()

◆ TCbBuffer() [1/4]

◆ TCbBuffer() [2/4]

◆ TCbBuffer() [3/4]

◆ TCbBuffer() [4/4]