UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | List of all members
FCbFieldViewIterator Class Reference

#include <CompactBinary.h>

+ Inheritance diagram for FCbFieldViewIterator:

Public Member Functions

constexpr FCbFieldViewIterator ()=default
 
template<typename OtherFieldType >
 FCbFieldViewIterator (const TCbFieldIterator< OtherFieldType > &It)
 
- Public Member Functions inherited from TCbFieldIterator< FCbFieldView >
constexpr TCbFieldIterator ()=default
 
CORE_API TCbFieldIterator & operator++ ()
 
TCbFieldIterator operator++ (int)
 
constexpr FCbFieldView & operator* ()
 
constexpr FCbFieldView * operator-> ()
 
void Reset ()
 
CORE_API uint64 GetRangeSize () const
 
CORE_API FIoHash GetRangeHash () const
 
CORE_API void AppendRangeHash (FIoHashBuilder &Builder) const
 
constexpr bool Equals (const TCbFieldIterator< OtherFieldType > &Other) const
 
constexpr bool operator== (const TCbFieldIterator< OtherFieldType > &Other) const
 
constexpr bool operator== (const FCbIteratorSentinel &) const
 
constexpr bool operator!= (const TCbFieldIterator< OtherFieldType > &Other) 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
 
- Public Member Functions inherited from FCbFieldView
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
 

Static Public Member Functions

static FCbFieldViewIterator MakeSingle (const FCbFieldView &Field)
 
static FCbFieldViewIterator MakeRange (FMemoryView View, ECbFieldType Type=ECbFieldType::HasFieldType)
 

Additional Inherited Members

- Protected Member Functions inherited from TCbFieldIterator< FCbFieldView >
constexpr TCbFieldIterator (FCbFieldView InField)
 
constexpr TCbFieldIterator (FCbFieldView &&InField, const void *InFieldsEnd)
 
- 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)
 
- Static Protected Member Functions inherited from TCbFieldIterator< FCbFieldView >
static const void * GetFieldsEnd (const TCbFieldIterator< OtherFieldType > &It)
 

Detailed Description

Iterator for FCbFieldView.

See also
TCbFieldIterator

Constructor & Destructor Documentation

◆ FCbFieldViewIterator() [1/2]

constexpr FCbFieldViewIterator::FCbFieldViewIterator ( )
constexprdefault

Construct an empty field range.

◆ FCbFieldViewIterator() [2/2]

template<typename OtherFieldType >
FCbFieldViewIterator::FCbFieldViewIterator ( const TCbFieldIterator< OtherFieldType > &  It)
inline

Construct an iterator from another iterator.

Member Function Documentation

◆ MakeRange()

static FCbFieldViewIterator FCbFieldViewIterator::MakeRange ( FMemoryView  View,
ECbFieldType  Type = ECbFieldType::HasFieldType 
)
inlinestatic

Construct a field range from a buffer containing zero or more valid fields.

Parameters
ViewA buffer containing zero or more valid fields.
TypeHasFieldType means that View contains the type. Otherwise, use the given type.

◆ MakeSingle()

static FCbFieldViewIterator FCbFieldViewIterator::MakeSingle ( const FCbFieldView &  Field)
inlinestatic

Construct a field range that contains exactly one field.

The documentation for this class was generated from the following file: