Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Serialization > TCbFieldIterator

Light Theme

Dark Theme

TCbFieldIterator

Iterator for [FCbField](API\Runtime\Core\Serialization\FCbField)[View] that can operate on any contiguous range of fields.

Choose your operating system:

Windows

macOS

Linux

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

	Name	Description
	TCbFieldIterator()	Construct an empty field range.
	TCbFieldIterator ( FieldType InField )	Construct a field range that contains exactly one field.
	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

	Name	Description
void	AppendRangeHash ( FIoHashBuilder& Builder )	Append the hash of every field in the range.
constexpr TC...	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 FC...	end()
constexpr bo...	Equals ( const TCbFieldIterator< OtherFieldT... )
const void &...	GetFieldsEnd ( const TCbFieldIterator< OtherFieldT... )	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

		Name	Description
	constexpr bo...	operator!= ( const FCbIteratorSentinel& )
	constexpr bo...	operator!= ( const TCbFieldIterator< OtherFieldT... )
	constexpr Fi...	operator*()
	TCbFieldIter...	operator++()
	TCbFieldIter...	operator++ ( int )
	constexpr bo...	operator== ( const TCbFieldIterator< OtherFieldT... )
	constexpr bo...	operator== ( const FCbIteratorSentinel& )
	constexpr Fi...	operator->()