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

#include <CompactBinary.h>

+ Inheritance diagram for FCbArray:
+ Collaboration diagram for FCbArray:

Public Member Functions

FCbField AsField () const &
 
FCbField AsField () &&
 
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< FCbArrayView >
 TCbBuffer ()=default
 
 TCbBuffer (FSharedBuffer ValueBuffer, ECbFieldType Type=ECbFieldType::HasFieldType)
 
 TCbBuffer (const FCbArrayView &Value, FSharedBuffer OuterBuffer)
 
 TCbBuffer (const FCbArrayView &Value, TCbBuffer< OtherViewType > OuterBuffer)
 
void Reset ()
 
bool IsOwned () const
 
void MakeOwned ()
 
const FCbArrayViewAsView () const
 
const FSharedBufferGetOuterBuffer () const &
 
FSharedBuffer GetOuterBuffer () &&
 
FCbField operator[] (FUtf8StringView Name) const
 
FCbFieldIterator CreateIterator () const
 
FCbFieldIterator begin () const
 
constexpr FCbIteratorSentinel end () const
 
- Public Member Functions inherited from FCbArrayView
 FCbArrayView ()
 
uint64 Num () const
 
FCbFieldView AsFieldView () const
 
 operator bool () const
 
uint64 GetSize () const
 
FIoHash GetHash () const
 
void AppendHash (FIoHashBuilder &Builder) const
 
bool Equals (const FCbArrayView &Other) const
 
void CopyTo (FMutableMemoryView Buffer) const
 
void CopyTo (FArchive &Ar) const
 
void IterateAttachments (FCbFieldVisitor Visitor) const
 
bool TryGetView (FMemoryView &OutView) const
 
constexpr FCbFieldView ()=default
 
 FCbFieldView (const void *Data, ECbFieldType Type=ECbFieldType::HasFieldType)
 
 FCbFieldView (const FCbValue &Value)
 
FCbFieldViewIterator CreateViewIterator () const
 
FCbFieldViewIterator begin () const
 
constexpr FCbIteratorSentinel end () const
 

Additional Inherited Members

- Static Public Member Functions inherited from FCbArrayView
static FCbArrayView FromFieldNoCheck (const FCbFieldView &Field)
 
- Static Public Member Functions inherited from TCbBufferFactory< FCbArray, FCbArrayView >
static FCbArray Clone (const void *const Data)
 
static FCbArray Clone (const FCbArrayView &Value)
 
static FCbArray MakeView (const void *const Data, FSharedBuffer OuterBuffer=FSharedBuffer())
 
static FCbArray MakeView (const FCbArrayView &Value, FSharedBuffer OuterBuffer=FSharedBuffer())
 
- 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)
 
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
 

Detailed Description

An array that includes a shared buffer for the memory that contains it.

See also
FCbArrayView
TCbBuffer

Definition at line 1364 of file CompactBinary.h.

Member Function Documentation

◆ AsField() [1/2]

FCbField FCbArray::AsField ( ) &&
inline

Definition at line 1371 of file CompactBinary.h.

◆ AsField() [2/2]

FCbField FCbArray::AsField ( ) const &
inline

Access the array as an array field.

Definition at line 1370 of file CompactBinary.h.

◆ GetBuffer()

FCompositeBuffer FCbArray::GetBuffer ( ) const

Returns a buffer that contains the array as it would be serialized by CopyTo.

◆ TCbBuffer() [1/4]

TCbBuffer< ViewType >::TCbBuffer ( )
default

Construct a default value.

◆ TCbBuffer() [2/4]

TCbBuffer< ViewType >::TCbBuffer ( const ViewType & Value,
FSharedBuffer OuterBuffer )
inline

Construct a value that holds a reference to the buffer that contains it.

Definition at line 1132 of file CompactBinary.h.

◆ TCbBuffer() [3/4]

template<typename OtherViewType >
TCbBuffer< ViewType >::TCbBuffer ( const ViewType & Value,
TCbBuffer< OtherViewType > OuterBuffer )
inline

Construct a value that holds a reference to the buffer of the outer that contains it.

Definition at line 1144 of file CompactBinary.h.

◆ TCbBuffer() [4/4]

TCbBuffer< ViewType >::TCbBuffer ( FSharedBuffer ValueBuffer,
ECbFieldType Type = ECbFieldType::HasFieldType )
inlineexplicit

Construct a value from a pointer to its data and an optional externally-provided type.

Parameters
ValueBufferA buffer that exactly contains the value.
TypeHasFieldType means that ValueBuffer contains the type. Otherwise, use the given type.

Definition at line 1121 of file CompactBinary.h.


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