Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
FCbFieldIterator Class Reference

#include <CompactBinary.h>

+ Inheritance diagram for FCbFieldIterator:
+ Collaboration diagram for FCbFieldIterator:

Public Member Functions

constexpr FCbFieldIterator ()=default
 
void MakeRangeOwned ()
 
- Public Member Functions inherited from TCbFieldIterator< FCbField >
constexpr TCbFieldIterator ()=default
 
TCbFieldIterator & operator++ ()
 
TCbFieldIterator operator++ (int)
 
constexpr FCbField & operator* ()
 
constexpr FCbField * operator-> ()
 
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 FCbField
FCbObject AsObject () &
 
FCbObject AsObject () &&
 
FCbArray AsArray () &
 
FCbArray AsArray () &&
 
FSharedBuffer AsBinary (const FSharedBuffer &Default=FSharedBuffer()) &
 
FSharedBuffer AsBinary (const FSharedBuffer &Default=FSharedBuffer()) &&
 
FCompositeBuffer GetBuffer () const
 
 TCbBuffer ()=default
 
 TCbBuffer (FSharedBuffer ValueBuffer, ECbFieldType Type=ECbFieldType::HasFieldType)
 
 TCbBuffer (const ViewType &Value, FSharedBuffer OuterBuffer)
 
template<typename OtherViewType >
 TCbBuffer (const ViewType &Value, TCbBuffer< OtherViewType > OuterBuffer)
 
- Public Member Functions inherited from TCbBuffer< FCbFieldView >
 TCbBuffer ()=default
 
 TCbBuffer (FSharedBuffer ValueBuffer, ECbFieldType Type=ECbFieldType::HasFieldType)
 
 TCbBuffer (const FCbFieldView &Value, FSharedBuffer OuterBuffer)
 
 TCbBuffer (const FCbFieldView &Value, TCbBuffer< OtherViewType > OuterBuffer)
 
void Reset ()
 
bool IsOwned () const
 
void MakeOwned ()
 
const FCbFieldView & AsView () const
 
const FSharedBuffer & GetOuterBuffer () const &
 
FSharedBuffer GetOuterBuffer () &&
 
FCbField operator[] (FUtf8StringView Name) const
 
FCbFieldIterator CreateIterator () const
 
FCbFieldIterator 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 FCbFieldIterator CloneRange (const FCbFieldViewIterator &It)
 
static FCbFieldIterator CloneRange (const FCbFieldIterator &It)
 
static FCbFieldIterator MakeSingle (FCbField Field)
 
static FCbFieldIterator MakeRange (FSharedBuffer Buffer, ECbFieldType Type=ECbFieldType::HasFieldType)
 
static FCbFieldIterator MakeRangeView (const FCbFieldViewIterator &It, FSharedBuffer OuterBuffer=FSharedBuffer())
 
- Static Public Member Functions inherited from TCbBufferFactory< FCbField, FCbFieldView >
static FCbField Clone (const void *const Data)
 
static FCbField Clone (const FCbFieldView &Value)
 
static FCbField MakeView (const void *const Data, FSharedBuffer OuterBuffer=FSharedBuffer())
 
static FCbField MakeView (const FCbFieldView &Value, FSharedBuffer OuterBuffer=FSharedBuffer())
 

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< FCbField >
constexpr TCbFieldIterator (FCbField InField)
 
constexpr TCbFieldIterator (FCbField &&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 void * GetValueData () const
 
const void * GetValueEnd () const
 
uint64 GetValueSize () const
 
void Assign (const void *InData, const ECbFieldType InType)
 
- Static Protected Member Functions inherited from TCbFieldIterator< FCbField >
static const void * GetFieldsEnd (const TCbFieldIterator< OtherFieldType > &It)
 

Detailed Description

Iterator for FCbField.

See also
TCbFieldIterator

Definition at line 1284 of file CompactBinary.h.

Constructor & Destructor Documentation

◆ FCbFieldIterator()

constexpr FCbFieldIterator::FCbFieldIterator ( )
constexprdefault

Construct an empty field range.

+ Here is the caller graph for this function:

Member Function Documentation

◆ CloneRange() [1/2]

static FCbFieldIterator FCbFieldIterator::CloneRange ( const FCbFieldIterator & It)
inlinestatic

Construct a field range from an owned clone of a range.

Definition at line 1291 of file CompactBinary.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ CloneRange() [2/2]

static FCbFieldIterator FCbFieldIterator::CloneRange ( const FCbFieldViewIterator & It)
static

Construct a field range from an owned clone of a range.

+ Here is the caller graph for this function:

◆ MakeRange()

static FCbFieldIterator FCbFieldIterator::MakeRange ( FSharedBuffer Buffer,
ECbFieldType Type = ECbFieldType::HasFieldType )
inlinestatic

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

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

Definition at line 1308 of file CompactBinary.h.

+ Here is the call graph for this function:

◆ MakeRangeOwned()

void FCbFieldIterator::MakeRangeOwned ( )
inline

Clone the range, if necessary, to a buffer that this has ownership of.

Definition at line 1328 of file CompactBinary.h.

+ Here is the call graph for this function:

◆ MakeRangeView()

static FCbFieldIterator FCbFieldIterator::MakeRangeView ( const FCbFieldViewIterator & It,
FSharedBuffer OuterBuffer = FSharedBuffer() )
inlinestatic

Construct a field range from an iterator and its optional outer buffer.

Definition at line 1319 of file CompactBinary.h.

◆ MakeSingle()

static FCbFieldIterator FCbFieldIterator::MakeSingle ( FCbField Field)
inlinestatic

Construct a field range that contains exactly one field.

Definition at line 1297 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: