Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FCbFieldViewIterator Class Reference

#include <CompactBinary.h>

+ Inheritance diagram for FCbFieldViewIterator:
+ Collaboration 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
 
TCbFieldIteratoroperator++ ()
 
TCbFieldIterator operator++ (int)
 
constexpr FCbFieldViewoperator* ()
 
constexpr FCbFieldViewoperator-> ()
 
void Reset ()
 
uint64 GetRangeSize () const
 
FIoHash GetRangeHash () const
 
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
 
void CopyRangeTo (FMutableMemoryView Buffer) const
 
void CopyRangeTo (FArchive &Ar) const
 
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
 
 FCbFieldView (const void *Data, ECbFieldType Type=ECbFieldType::HasFieldType)
 
 FCbFieldView (const FCbValue &Value)
 
constexpr FCbFieldView RemoveName () const
 
constexpr FUtf8StringView GetName () const
 
FCbValue GetValue () const
 
FCbObjectView AsObjectView ()
 
FCbArrayView AsArrayView ()
 
FMemoryView AsBinaryView (FMemoryView Default=FMemoryView())
 
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)
 
float AsFloat (float Default=0.0f)
 
double AsDouble (double Default=0.0)
 
bool AsBool (bool bDefault=false)
 
FIoHash AsObjectAttachment (const FIoHash &Default=FIoHash())
 
FIoHash AsBinaryAttachment (const FIoHash &Default=FIoHash())
 
FIoHash AsAttachment (const FIoHash &Default=FIoHash())
 
FIoHash AsHash (const FIoHash &Default=FIoHash())
 
FGuid AsUuid ()
 
FGuid AsUuid (const FGuid &Default)
 
int64 AsDateTimeTicks (int64 Default=0)
 
FDateTime AsDateTime ()
 
FDateTime AsDateTime (FDateTime Default)
 
int64 AsTimeSpanTicks (int64 Default=0)
 
FTimespan AsTimeSpan ()
 
FTimespan AsTimeSpan (FTimespan Default)
 
FCbObjectId AsObjectId (const FCbObjectId &Default=FCbObjectId())
 
FCbCustomById AsCustomById (FCbCustomById Default=FCbCustomById())
 
FCbCustomByName AsCustomByName (FCbCustomByName Default=FCbCustomByName())
 
FMemoryView AsCustom (uint64 Id, FMemoryView Default=FMemoryView())
 
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
 
uint64 GetSize () const
 
FIoHash GetHash () const
 
void AppendHash (FIoHashBuilder &Builder) const
 
bool Equals (const FCbFieldView &Other) const
 
void CopyTo (FMutableMemoryView Buffer) const
 
void CopyTo (FArchive &Ar) const
 
void IterateAttachments (FCbFieldVisitor Visitor) const
 
bool TryGetView (FMemoryView &OutView) const
 
FCbFieldView operator[] (FUtf8StringView Name) const
 
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)
 

Private Member Functions

constexpr TCbFieldIterator ()=default
 
constexpr TCbFieldIterator (FieldType InField)
 
constexpr TCbFieldIterator (FieldType &&InField, const void *InFieldsEnd)
 

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
FMemoryView GetView () const
 
FMemoryView GetViewNoType () const
 
FMemoryView GetValueView () const
 
constexpr ECbFieldType GetType () const
 
constexpr ECbFieldType GetTypeWithFlags () const
 
constexpr const voidGetValueData () const
 
const voidGetValueEnd () const
 
uint64 GetValueSize () const
 
void Assign (const void *InData, const ECbFieldType InType)
 
- Static Protected Member Functions inherited from TCbFieldIterator< FCbFieldView >
static const voidGetFieldsEnd (const TCbFieldIterator< OtherFieldType > &It)
 

Detailed Description

Iterator for FCbFieldView.

See also
TCbFieldIterator

Definition at line 888 of file CompactBinary.h.

Constructor & Destructor Documentation

◆ FCbFieldViewIterator() [1/2]

constexpr FCbFieldViewIterator::FCbFieldViewIterator ( )
constexprdefault

Construct an empty field range.

◆ FCbFieldViewIterator() [2/2]

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

Construct an iterator from another iterator.

Definition at line 913 of file CompactBinary.h.

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.

Definition at line 903 of file CompactBinary.h.

◆ MakeSingle()

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

Construct a field range that contains exactly one field.

Definition at line 892 of file CompactBinary.h.

◆ TCbFieldIterator() [1/3]

constexpr TCbFieldIterator< FieldType >::TCbFieldIterator ( )
constexprprivatedefault

Construct an empty field range.

◆ TCbFieldIterator() [2/3]

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

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

Parameters
InFieldThe first field, or the default field if there are no fields.
InFieldsEndA pointer to the end of the value of the last field, or null.

Definition at line 437 of file CompactBinary.h.

◆ TCbFieldIterator() [3/3]

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

Construct a field range that contains exactly one field.

Definition at line 425 of file CompactBinary.h.


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