TCbFieldIterator< FieldType > Class Template Reference

#include <CompactBinary.h>

Inheritance diagram for TCbFieldIterator< FieldType >:

Public Member Functions
constexpr	TCbFieldIterator ()=default
CORE_API TCbFieldIterator &	operator++ ()
TCbFieldIterator	operator++ (int)
constexpr FieldType &	operator* ()
constexpr FieldType *	operator-> ()
void	Reset ()
CORE_API uint64	GetRangeSize () const
CORE_API FIoHash	GetRangeHash () const
CORE_API void	AppendRangeHash (FIoHashBuilder &Builder) const
template<typename OtherFieldType >
constexpr bool	Equals (const TCbFieldIterator< OtherFieldType > &Other) const
template<typename OtherFieldType >
constexpr bool	operator== (const TCbFieldIterator< OtherFieldType > &Other) const
template<typename OtherFieldType >
constexpr bool	operator!= (const TCbFieldIterator< OtherFieldType > &Other) const
constexpr bool	operator== (const FCbIteratorSentinel &) const
constexpr bool	operator!= (const FCbIteratorSentinel &) const
CORE_API void	CopyRangeTo (FMutableMemoryView Buffer) const
CORE_API void	CopyRangeTo (FArchive &Ar) const
CORE_API void	IterateRangeAttachments (FCbFieldVisitor Visitor) const
bool	TryGetRangeView (FMemoryView &OutView) const
constexpr TCbFieldIterator	begin () const
constexpr FCbIteratorSentinel	end () const

Protected Member Functions
constexpr	TCbFieldIterator (FieldType InField)
constexpr	TCbFieldIterator (FieldType &&InField, const void *InFieldsEnd)

Static Protected Member Functions
template<typename OtherFieldType >
static const void *	GetFieldsEnd (const TCbFieldIterator< OtherFieldType > &It)

Friends
template<typename OtherType >
class	TCbFieldIterator

Detailed Description

template<typename FieldType>
class TCbFieldIterator< FieldType >

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.

Constructor & Destructor Documentation

TCbFieldIterator() [1/3]

template<typename FieldType >

constexpr TCbFieldIterator< FieldType >::TCbFieldIterator ( )

constexprdefault

Construct an empty field range.

TCbFieldIterator() [2/3]

template<typename FieldType >

constexpr TCbFieldIterator< FieldType >::TCbFieldIterator ( FieldType  InField )

inlineexplicitconstexprprotected

Construct a field range that contains exactly one field.

TCbFieldIterator() [3/3]

template<typename FieldType >

constexpr TCbFieldIterator< FieldType >::TCbFieldIterator ( FieldType &&  InField, const void *  InFieldsEnd  )

inlineconstexprprotected

Construct a field range from the first field and a pointer to the end of the last field.

Parameters

InField	The first field, or the default field if there are no fields.
InFieldsEnd	A pointer to the end of the value of the last field, or null.

Member Function Documentation

AppendRangeHash()

template<typename FieldType >

void TCbFieldIterator< FieldType >::AppendRangeHash

(

FIoHashBuilder &

Builder

)

const

Append the hash of every field in the range.

begin()

template<typename FieldType >

constexpr TCbFieldIterator TCbFieldIterator< FieldType >::begin ( ) const

inlineconstexpr

DO NOT USE DIRECTLY. These functions enable range-based for loop support.

CopyRangeTo() [1/2]

template<typename FieldType >

void TCbFieldIterator< FieldType >::CopyRangeTo

(

FArchive &

Ar

)

const

Copy the field range into an archive, as if calling CopyTo on every field.

CopyRangeTo() [2/2]

template<typename FieldType >

void TCbFieldIterator< FieldType >::CopyRangeTo

(

FMutableMemoryView

Buffer

)

const

Copy the field range into a buffer of exactly GetRangeSize() bytes.

end()

template<typename FieldType >

constexpr FCbIteratorSentinel TCbFieldIterator< FieldType >::end ( ) const

inlineconstexpr

Equals()

template<typename FieldType >

template<typename OtherFieldType >

constexpr bool TCbFieldIterator< FieldType >::Equals ( const TCbFieldIterator< OtherFieldType > &  Other ) const

inlineconstexpr

GetFieldsEnd()

template<typename FieldType >

template<typename OtherFieldType >

static const void * TCbFieldIterator< FieldType >::GetFieldsEnd ( const TCbFieldIterator< OtherFieldType > &  It )

inlinestaticprotected

Returns the end of the last field, or null for an iterator at the end.

GetRangeHash()

template<typename FieldType >

FIoHash TCbFieldIterator< FieldType >::GetRangeHash

(

)

const

Calculate the hash of every field in the range.

GetRangeSize()

template<typename FieldType >

uint64 TCbFieldIterator< FieldType >::GetRangeSize

(

)

const

Returns the size of the fields in the range in bytes.

IterateRangeAttachments()

template<typename FieldType >

void TCbFieldIterator< FieldType >::IterateRangeAttachments

(

FCbFieldVisitor

Visitor

)

const

Invoke the visitor for every attachment in the field range.

operator!=() [1/2]

template<typename FieldType >

constexpr bool TCbFieldIterator< FieldType >::operator!= ( const FCbIteratorSentinel &  ) const

inlineconstexpr

operator!=() [2/2]

template<typename FieldType >

template<typename OtherFieldType >

constexpr bool TCbFieldIterator< FieldType >::operator!= ( const TCbFieldIterator< OtherFieldType > &  Other ) const

inlineconstexpr

operator*()

template<typename FieldType >

constexpr FieldType & TCbFieldIterator< FieldType >::operator* ( )

inlineconstexpr

operator++() [1/2]

template<typename FieldType >

TCbFieldIterator< FieldType > & TCbFieldIterator< FieldType >::operator++

(

)

operator++() [2/2]

template<typename FieldType >

TCbFieldIterator TCbFieldIterator< FieldType >::operator++ ( int  )

inline

operator->()

template<typename FieldType >

constexpr FieldType * TCbFieldIterator< FieldType >::operator-> ( )

inlineconstexpr

operator==() [1/2]

template<typename FieldType >

constexpr bool TCbFieldIterator< FieldType >::operator== ( const FCbIteratorSentinel &  ) const

inlineconstexpr

operator==() [2/2]

template<typename FieldType >

template<typename OtherFieldType >

constexpr bool TCbFieldIterator< FieldType >::operator== ( const TCbFieldIterator< OtherFieldType > &  Other ) const

inlineconstexpr

Reset()

template<typename FieldType >

void TCbFieldIterator< FieldType >::Reset ( )

inline

Reset this to an empty field range.

TryGetRangeView()

template<typename FieldType >

bool TCbFieldIterator< FieldType >::TryGetRangeView ( FMemoryView &  OutView ) const

inline

Try to get a view of every field in the range as they would be serialized.

A view is available if each field contains its type. Access the equivalent for other field ranges through FCbFieldIterator::CloneRange or CopyRangeTo.

Friends And Related Symbol Documentation

TCbFieldIterator

template<typename FieldType >

template<typename OtherType >

friend class TCbFieldIterator

friend

---

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