FCbArrayView | Unreal Engine 5.6 Documentation

Array of FCbField[View] that have no names.

Accessing a field of the array requires iteration. Access by index is not provided because the cost of accessing an item by index scales linearly with the index.

This type only provides a view into memory and does not perform any memory management itself. Use FCbArray to hold a reference to the underlying memory when necessary.


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

Syntax

class FCbArrayView : protected FCbFieldView

Inheritance Hierarchy

FCbFieldView → FCbArrayView

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FCbArrayView ( const FCbFieldView& Field )	Construct an array from an array field. No type check is performed! Use via FromFieldNoCheck.	Serialization/CompactBinary.h
FCbArrayView ()	Construct an array with no fields.	Serialization/CompactBinary.h

Functions

Public

Name	Remarks	Include Path
void AppendHash ( FIoHashBuilder& Builder ) const	Append the hash of the array if serialized by itself with no name.	Serialization/CompactBinary.h
FCbFieldView AsFieldView()	Access the array as an array field.	Serialization/CompactBinary.h
FCbFieldViewIterator begin()	DO NOT USE DIRECTLY. These functions enable range-based for loop support.	Serialization/CompactBinary.h
void CopyTo ( FArchive& Ar ) const	Copy the array into an archive. This will write GetSize() bytes, with no name.	Serialization/CompactBinary.h
void CopyTo ( FMutableMemoryView Buffer ) const	Copy the array into a buffer of exactly GetSize() bytes, with no name.	Serialization/CompactBinary.h
FCbFieldViewIterator CreateViewIterator ()		Serialization/CompactBinary.h
FCbIteratorSentinel end()		Serialization/CompactBinary.h
bool Equals ( const FCbArrayView& Other ) const	Whether this array is identical to the other array.	Serialization/CompactBinary.h
constexpr FCbFieldView ()		Serialization/CompactBinary.h
FCbFieldView ( const void* Data, ECbFieldType Type )		Serialization/CompactBinary.h
FCbFieldView ( const FCbValue& Value )		Serialization/CompactBinary.h
FIoHash GetHash()	Calculate the hash of the array if serialized by itself with no name.	Serialization/CompactBinary.h
uint64 GetSize()	Returns the size of the array in bytes if serialized by itself with no name.	Serialization/CompactBinary.h
void IterateAttachments ( FCbFieldVisitor Visitor ) const	Invoke the visitor for every attachment in the array.	Serialization/CompactBinary.h
uint64 Num()	Returns the number of items in the array.	Serialization/CompactBinary.h
bool TryGetView ( FMemoryView& OutView ) const	Try to get a view of the array as it would be serialized, such as by CopyTo.	Serialization/CompactBinary.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static FCbArrayView FromFieldNoCheck ( const FCbFieldView& Field )	Construct an array from an array field. No type check is performed!	Serialization/CompactBinary.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
operator bool()	Whether the array has any fields.	Serialization/CompactBinary.h

Navigation