UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TCbWriter< InlineBufferSize > Class Template Reference

#include <CompactBinaryWriter.h>

+ Inheritance diagram for TCbWriter< InlineBufferSize >:

Public Member Functions

 TCbWriter ()
 
 TCbWriter (const TCbWriter &)=delete
 
TCbWriteroperator= (const TCbWriter &)=delete
 
- Public Member Functions inherited from FCbWriter
CORE_API FCbWriter ()
 
CORE_API ~FCbWriter ()
 
 FCbWriter (const FCbWriter &)=delete
 
FCbWriteroperator= (const FCbWriter &)=delete
 
CORE_API void Reset ()
 
CORE_API FCbFieldIterator Save () const
 
CORE_API FCbFieldViewIterator Save (FMutableMemoryView Buffer) const
 
CORE_API void Save (FArchive &Ar) const
 
CORE_API uint64 GetSaveSize () const
 
CORE_API FCbWriterSetName (FUtf8StringView Name)
 
void AddField (FUtf8StringView Name, const FCbFieldView &Value)
 
CORE_API void AddField (const FCbFieldView &Value)
 
void AddField (FUtf8StringView Name, const FCbField &Value)
 
CORE_API void AddField (const FCbField &Value)
 
void BeginObject (FUtf8StringView Name)
 
CORE_API void BeginObject ()
 
CORE_API void EndObject ()
 
void AddObject (FUtf8StringView Name, const FCbObjectView &Value)
 
CORE_API void AddObject (const FCbObjectView &Value)
 
void AddObject (FUtf8StringView Name, const FCbObject &Value)
 
CORE_API void AddObject (const FCbObject &Value)
 
void BeginArray (FUtf8StringView Name)
 
CORE_API void BeginArray ()
 
CORE_API void EndArray ()
 
void AddArray (FUtf8StringView Name, const FCbArrayView &Value)
 
CORE_API void AddArray (const FCbArrayView &Value)
 
void AddArray (FUtf8StringView Name, const FCbArray &Value)
 
CORE_API void AddArray (const FCbArray &Value)
 
void AddNull (FUtf8StringView Name)
 
CORE_API void AddNull ()
 
void AddBinary (FUtf8StringView Name, const void *Value, uint64 Size)
 
CORE_API void AddBinary (const void *Value, uint64 Size)
 
void AddBinary (FUtf8StringView Name, FMemoryView Value)
 
void AddBinary (FMemoryView Value)
 
void AddBinary (FUtf8StringView Name, const FSharedBuffer &Value)
 
CORE_API void AddBinary (const FSharedBuffer &Value)
 
void AddBinary (FUtf8StringView Name, const FCompositeBuffer &Value)
 
CORE_API void AddBinary (const FCompositeBuffer &Value)
 
void AddString (FUtf8StringView Name, FUtf8StringView Value)
 
CORE_API void AddString (FUtf8StringView Value)
 
void AddString (FUtf8StringView Name, FWideStringView Value)
 
CORE_API void AddString (FWideStringView Value)
 
void AddInteger (FUtf8StringView Name, int32 Value)
 
CORE_API void AddInteger (int32 Value)
 
void AddInteger (FUtf8StringView Name, int64 Value)
 
CORE_API void AddInteger (int64 Value)
 
void AddInteger (FUtf8StringView Name, uint32 Value)
 
CORE_API void AddInteger (uint32 Value)
 
void AddInteger (FUtf8StringView Name, uint64 Value)
 
CORE_API void AddInteger (uint64 Value)
 
void AddFloat (FUtf8StringView Name, float Value)
 
CORE_API void AddFloat (float Value)
 
void AddFloat (FUtf8StringView Name, double Value)
 
CORE_API void AddFloat (double Value)
 
void AddBool (FUtf8StringView Name, bool bValue)
 
CORE_API void AddBool (bool bValue)
 
void AddObjectAttachment (FUtf8StringView Name, const FIoHash &Value)
 
CORE_API void AddObjectAttachment (const FIoHash &Value)
 
void AddBinaryAttachment (FUtf8StringView Name, const FIoHash &Value)
 
CORE_API void AddBinaryAttachment (const FIoHash &Value)
 
void AddAttachment (FUtf8StringView Name, const FCbAttachment &Attachment)
 
CORE_API void AddAttachment (const FCbAttachment &Attachment)
 
void AddHash (FUtf8StringView Name, const FIoHash &Value)
 
CORE_API void AddHash (const FIoHash &Value)
 
void AddUuid (FUtf8StringView Name, const FGuid &Value)
 
CORE_API void AddUuid (const FGuid &Value)
 
void AddDateTimeTicks (FUtf8StringView Name, int64 Ticks)
 
CORE_API void AddDateTimeTicks (int64 Ticks)
 
CORE_API void AddDateTime (FUtf8StringView Name, FDateTime Value)
 
CORE_API void AddDateTime (FDateTime Value)
 
void AddTimeSpanTicks (FUtf8StringView Name, int64 Ticks)
 
CORE_API void AddTimeSpanTicks (int64 Ticks)
 
CORE_API void AddTimeSpan (FUtf8StringView Name, FTimespan Value)
 
CORE_API void AddTimeSpan (FTimespan Value)
 
void AddObjectId (FUtf8StringView Name, const FCbObjectId &Value)
 
CORE_API void AddObjectId (const FCbObjectId &Value)
 
void AddCustom (FUtf8StringView FieldName, uint64 TypeId, FMemoryView Value)
 
CORE_API void AddCustom (uint64 TypeId, FMemoryView Value)
 
void AddCustom (FUtf8StringView FieldName, FUtf8StringView TypeName, FMemoryView Value)
 
CORE_API void AddCustom (FUtf8StringView TypeName, FMemoryView Value)
 
FCbWriteroperator<< (FUtf8StringView NameOrValue)
 
FCbWriteroperator<< (const ANSICHAR *NameOrValue)
 
FCbWriteroperator<< (const UTF8CHAR *NameOrValue)
 
FCbWriteroperator<< (const FCbFieldView &Value)
 
FCbWriteroperator<< (const FCbField &Value)
 
FCbWriteroperator<< (const FCbObjectView &Value)
 
FCbWriteroperator<< (const FCbObject &Value)
 
FCbWriteroperator<< (const FCbArrayView &Value)
 
FCbWriteroperator<< (const FCbArray &Value)
 
FCbWriteroperator<< (TYPE_OF_NULLPTR)
 
FCbWriteroperator<< (FWideStringView Value)
 
FCbWriteroperator<< (const WIDECHAR *Value)
 
FCbWriteroperator<< (int32 Value)
 
FCbWriteroperator<< (int64 Value)
 
FCbWriteroperator<< (uint32 Value)
 
FCbWriteroperator<< (uint64 Value)
 
FCbWriteroperator<< (float Value)
 
FCbWriteroperator<< (double Value)
 
FCbWriteroperator<< (bool Value)
 
FCbWriteroperator<< (const FCbAttachment &Attachment)
 
FCbWriteroperator<< (const FIoHash &Value)
 
FCbWriteroperator<< (const FGuid &Value)
 
CORE_API FCbWriteroperator<< (FDateTime Value)
 
CORE_API FCbWriteroperator<< (FTimespan Value)
 
FCbWriteroperator<< (const FCbObjectId &Value)
 
CORE_API FCbWriteroperator<< (const FString &Value)
 
CORE_API FCbWriteroperator<< (const FAnsiString &Value)
 
CORE_API FCbWriteroperator<< (const FUtf8String &Value)
 
CORE_API FCbWriteroperator<< (FName Value)
 
template<typename T , typename Allocator , std::void_t< decltype(std::declval< FCbWriter & >()<< std::declval< const T & >())> * = nullptr>
FCbWriteroperator<< (const TArray< T, Allocator > &Value)
 

Additional Inherited Members

- Public Types inherited from FCbWriter
enum class  EStateFlags : uint8 {
  None = 0 , Name = 1 << 0 , Field = 1 << 1 , Array = 1 << 2 ,
  Object = 1 << 3
}
 
- Protected Member Functions inherited from FCbWriter
CORE_API FCbWriter (int64 InitialSize)
 

Detailed Description

template<uint32 InlineBufferSize>
class TCbWriter< InlineBufferSize >

A writer for compact binary object, arrays, and fields that uses a fixed-size stack buffer.

See also
FCbWriter

Constructor & Destructor Documentation

◆ TCbWriter() [1/2]

template<uint32 InlineBufferSize>
TCbWriter< InlineBufferSize >::TCbWriter ( )
inline

◆ TCbWriter() [2/2]

template<uint32 InlineBufferSize>
TCbWriter< InlineBufferSize >::TCbWriter ( const TCbWriter< InlineBufferSize > &  )
delete

Member Function Documentation

◆ operator=()

template<uint32 InlineBufferSize>
TCbWriter & TCbWriter< InlineBufferSize >::operator= ( const TCbWriter< InlineBufferSize > &  )
delete

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