TCbFieldIterator | Unreal Engine 5.2 Documentation

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Serialization

Inheritance Hierarchy

FieldType
TCbFieldIterator
FCbFieldIterator
FCbFieldViewIterator

References


Module	Core
Header	/Engine/Source/Runtime/Core/Public/Serialization/CompactBinary.h
Include	#include "Serialization/CompactBinary.h"

Syntax

template<typename FieldType>  
class TCbFieldIterator : public FieldType

Remarks

Iterator for FCbField[View] that can operate on any contiguous range of fields.

The iterator is the current field that the iterator points to and exposes the full interface of FCbField[View]. An iterator that is at the end is equivalent to a field with no value.

The iterator represents a range of fields from the current field to the last field.

Constructors

Type	Name	Description
constexpr	TCbFieldIterator ()	Construct an empty field range.
constexpr	TCbFieldIterator ( FieldType InField )	Construct a field range that contains exactly one field.
constexpr	TCbFieldIterator ( FieldType&& InField, const void* InFieldsEnd )	Construct a field range from the first field and a pointer to the end of the last field.

Functions

Type	Name	Description
void	AppendRangeHash ( FIoHashBuilder& Builder )	Append the hash of every field in the range.
constexpr TCbFieldIterator	begin ()	DO NOT USE DIRECTLY. These functions enable range-based for loop support.
void	CopyRangeTo ( FArchive& Ar )	Copy the field range into an archive, as if calling CopyTo on every field.
void	CopyRangeTo ( FMutableMemoryView Buffer )	Copy the field range into a buffer of exactly GetRangeSize() bytes.
constexpr FCbIteratorSentinel	end ()
constexpr bool	Equals ( const TCbFieldIterator< OtherFieldType >& Other )
const void *	GetFieldsEnd ( const TCbFieldIterator< OtherFieldType >& It )	Returns the end of the last field, or null for an iterator at the end.
FIoHash	GetRangeHash ()	Calculate the hash of every field in the range.
uint64	GetRangeSize ()	Returns the size of the fields in the range in bytes.
void	IterateRangeAttachments ( FCbFieldVisitor Visitor )	Invoke the visitor for every attachment in the field range.
void	Reset ()	Reset this to an empty field range.
bool	TryGetRangeView ( FMemoryView& OutView )	Try to get a view of every field in the range as they would be serialized.

Operators

	Type	Name	Description
	constexpr bool	operator!= ( const FCbIteratorSentinel& )
	constexpr bool	operator!= ( const TCbFieldIterator< OtherFieldType >& Other )
	constexpr FieldType &	operator* ()
	TCbFieldIterator &	operator++ ()
	TCbFieldIterator	operator++ ( int )
	constexpr bool	operator== ( const TCbFieldIterator< OtherFieldType >& Other )
	constexpr bool	operator== ( const FCbIteratorSentinel& )
	constexpr FieldType *	operator-> ()

Navigation